@aws-sdk/client-groundstation 3.379.1 → 3.382.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.
@@ -8,6 +8,7 @@ export declare class DependencyException extends __BaseException {
8
8
  readonly name: "DependencyException";
9
9
  readonly $fault: "server";
10
10
  /**
11
+ * @public
11
12
  * <p/>
12
13
  */
13
14
  parameterName?: string;
@@ -21,6 +22,7 @@ export declare class DependencyException extends __BaseException {
21
22
  */
22
23
  export interface GetAgentConfigurationRequest {
23
24
  /**
25
+ * @public
24
26
  * <p>UUID of agent to get configuration information for.</p>
25
27
  */
26
28
  agentId: string | undefined;
@@ -30,10 +32,12 @@ export interface GetAgentConfigurationRequest {
30
32
  */
31
33
  export interface GetAgentConfigurationResponse {
32
34
  /**
35
+ * @public
33
36
  * <p>UUID of agent.</p>
34
37
  */
35
38
  agentId?: string;
36
39
  /**
40
+ * @public
37
41
  * <p>Tasking document for agent.</p>
38
42
  */
39
43
  taskingDocument?: string;
@@ -46,6 +50,7 @@ export declare class InvalidParameterException extends __BaseException {
46
50
  readonly name: "InvalidParameterException";
47
51
  readonly $fault: "client";
48
52
  /**
53
+ * @public
49
54
  * <p/>
50
55
  */
51
56
  parameterName?: string;
@@ -72,10 +77,12 @@ export declare class ResourceNotFoundException extends __BaseException {
72
77
  */
73
78
  export interface ComponentVersion {
74
79
  /**
80
+ * @public
75
81
  * <p>Component type.</p>
76
82
  */
77
83
  componentType: string | undefined;
78
84
  /**
85
+ * @public
79
86
  * <p>List of versions.</p>
80
87
  */
81
88
  versions: string[] | undefined;
@@ -86,18 +93,22 @@ export interface ComponentVersion {
86
93
  */
87
94
  export interface AgentDetails {
88
95
  /**
96
+ * @public
89
97
  * <p>Current agent version.</p>
90
98
  */
91
99
  agentVersion: string | undefined;
92
100
  /**
101
+ * @public
93
102
  * <p>ID of EC2 instance agent is running on.</p>
94
103
  */
95
104
  instanceId: string | undefined;
96
105
  /**
106
+ * @public
97
107
  * <p>Type of EC2 instance agent is running on.</p>
98
108
  */
99
109
  instanceType: string | undefined;
100
110
  /**
111
+ * @public
101
112
  * <note>
102
113
  * <p>This field should not be used. Use agentCpuCores instead.</p>
103
114
  * </note>
@@ -105,10 +116,12 @@ export interface AgentDetails {
105
116
  */
106
117
  reservedCpuCores?: number[];
107
118
  /**
119
+ * @public
108
120
  * <p>List of CPU cores reserved for the agent.</p>
109
121
  */
110
122
  agentCpuCores?: number[];
111
123
  /**
124
+ * @public
112
125
  * <p>List of versions being used by agent components.</p>
113
126
  */
114
127
  componentVersions: ComponentVersion[] | undefined;
@@ -119,14 +132,17 @@ export interface AgentDetails {
119
132
  */
120
133
  export interface DiscoveryData {
121
134
  /**
135
+ * @public
122
136
  * <p>List of public IP addresses to associate with agent.</p>
123
137
  */
124
138
  publicIpAddresses: string[] | undefined;
125
139
  /**
140
+ * @public
126
141
  * <p>List of private IP addresses to associate with agent.</p>
127
142
  */
128
143
  privateIpAddresses: string[] | undefined;
129
144
  /**
145
+ * @public
130
146
  * <p>List of capabilities to associate with agent.</p>
131
147
  */
132
148
  capabilityArns: string[] | undefined;
@@ -136,10 +152,12 @@ export interface DiscoveryData {
136
152
  */
137
153
  export interface RegisterAgentRequest {
138
154
  /**
155
+ * @public
139
156
  * <p>Data for associating an agent with the capabilities it is managing.</p>
140
157
  */
141
158
  discoveryData: DiscoveryData | undefined;
142
159
  /**
160
+ * @public
143
161
  * <p>Detailed information about the agent being registered.</p>
144
162
  */
145
163
  agentDetails: AgentDetails | undefined;
@@ -149,6 +167,7 @@ export interface RegisterAgentRequest {
149
167
  */
150
168
  export interface RegisterAgentResponse {
151
169
  /**
170
+ * @public
152
171
  * <p>UUID of registered agent.</p>
153
172
  */
154
173
  agentId?: string;
@@ -173,10 +192,12 @@ export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];
173
192
  */
174
193
  export interface AggregateStatus {
175
194
  /**
195
+ * @public
176
196
  * <p>Aggregate status.</p>
177
197
  */
178
198
  status: AgentStatus | string | undefined;
179
199
  /**
200
+ * @public
180
201
  * <p>Sparse map of failure signatures.</p>
181
202
  */
182
203
  signatureMap?: Record<string, boolean>;
@@ -187,30 +208,37 @@ export interface AggregateStatus {
187
208
  */
188
209
  export interface ComponentStatusData {
189
210
  /**
211
+ * @public
190
212
  * <p>The Component type.</p>
191
213
  */
192
214
  componentType: string | undefined;
193
215
  /**
216
+ * @public
194
217
  * <p>Capability ARN of the component.</p>
195
218
  */
196
219
  capabilityArn: string | undefined;
197
220
  /**
221
+ * @public
198
222
  * <p>Component status.</p>
199
223
  */
200
224
  status: AgentStatus | string | undefined;
201
225
  /**
226
+ * @public
202
227
  * <p>Bytes sent by the component.</p>
203
228
  */
204
229
  bytesSent?: number;
205
230
  /**
231
+ * @public
206
232
  * <p>Bytes received by the component.</p>
207
233
  */
208
234
  bytesReceived?: number;
209
235
  /**
236
+ * @public
210
237
  * <p>Packets dropped by component.</p>
211
238
  */
212
239
  packetsDropped?: number;
213
240
  /**
241
+ * @public
214
242
  * <p>Dataflow UUID associated with the component.</p>
215
243
  */
216
244
  dataflowId: string | undefined;
@@ -220,18 +248,22 @@ export interface ComponentStatusData {
220
248
  */
221
249
  export interface UpdateAgentStatusRequest {
222
250
  /**
251
+ * @public
223
252
  * <p>UUID of agent to update.</p>
224
253
  */
225
254
  agentId: string | undefined;
226
255
  /**
256
+ * @public
227
257
  * <p>GUID of agent task.</p>
228
258
  */
229
259
  taskId: string | undefined;
230
260
  /**
261
+ * @public
231
262
  * <p>Aggregate status for agent.</p>
232
263
  */
233
264
  aggregateStatus: AggregateStatus | undefined;
234
265
  /**
266
+ * @public
235
267
  * <p>List of component statuses for agent.</p>
236
268
  */
237
269
  componentStatuses: ComponentStatusData[] | undefined;
@@ -241,6 +273,7 @@ export interface UpdateAgentStatusRequest {
241
273
  */
242
274
  export interface UpdateAgentStatusResponse {
243
275
  /**
276
+ * @public
244
277
  * <p>UUID of updated agent.</p>
245
278
  */
246
279
  agentId: string | undefined;
@@ -263,6 +296,7 @@ export type AngleUnits = (typeof AngleUnits)[keyof typeof AngleUnits];
263
296
  */
264
297
  export interface AntennaDemodDecodeDetails {
265
298
  /**
299
+ * @public
266
300
  * <p>Name of an antenna demod decode output node used in a contact.</p>
267
301
  */
268
302
  outputNode?: string;
@@ -286,6 +320,7 @@ export type BandwidthUnits = (typeof BandwidthUnits)[keyof typeof BandwidthUnits
286
320
  */
287
321
  export interface FrequencyBandwidth {
288
322
  /**
323
+ * @public
289
324
  * <p>Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:</p>
290
325
  * <ul>
291
326
  * <li>
@@ -301,6 +336,7 @@ export interface FrequencyBandwidth {
301
336
  */
302
337
  value: number | undefined;
303
338
  /**
339
+ * @public
304
340
  * <p>Frequency bandwidth units.</p>
305
341
  */
306
342
  units: BandwidthUnits | string | undefined;
@@ -324,10 +360,12 @@ export type FrequencyUnits = (typeof FrequencyUnits)[keyof typeof FrequencyUnits
324
360
  */
325
361
  export interface Frequency {
326
362
  /**
363
+ * @public
327
364
  * <p>Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.</p>
328
365
  */
329
366
  value: number | undefined;
330
367
  /**
368
+ * @public
331
369
  * <p>Frequency units.</p>
332
370
  */
333
371
  units: FrequencyUnits | string | undefined;
@@ -351,10 +389,12 @@ export type Polarization = (typeof Polarization)[keyof typeof Polarization];
351
389
  */
352
390
  export interface SpectrumConfig {
353
391
  /**
392
+ * @public
354
393
  * <p>Center frequency of a spectral <code>Config</code>. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.</p>
355
394
  */
356
395
  centerFrequency: Frequency | undefined;
357
396
  /**
397
+ * @public
358
398
  * <p>Bandwidth of a spectral <code>Config</code>. AWS Ground Station currently has the following bandwidth limitations:</p>
359
399
  * <ul>
360
400
  * <li>
@@ -370,6 +410,7 @@ export interface SpectrumConfig {
370
410
  */
371
411
  bandwidth: FrequencyBandwidth | undefined;
372
412
  /**
413
+ * @public
373
414
  * <p>Polarization of a spectral <code>Config</code>. Capturing both <code>"RIGHT_HAND"</code> and <code>"LEFT_HAND"</code> polarization requires two separate configs.</p>
374
415
  */
375
416
  polarization?: Polarization | string;
@@ -381,6 +422,7 @@ export interface SpectrumConfig {
381
422
  */
382
423
  export interface AntennaDownlinkConfig {
383
424
  /**
425
+ * @public
384
426
  * <p>Object that describes a spectral <code>Config</code>.</p>
385
427
  */
386
428
  spectrumConfig: SpectrumConfig | undefined;
@@ -391,6 +433,7 @@ export interface AntennaDownlinkConfig {
391
433
  */
392
434
  export interface DecodeConfig {
393
435
  /**
436
+ * @public
394
437
  * <p>Unvalidated JSON of a decode <code>Config</code>.</p>
395
438
  */
396
439
  unvalidatedJSON: string | undefined;
@@ -401,6 +444,7 @@ export interface DecodeConfig {
401
444
  */
402
445
  export interface DemodulationConfig {
403
446
  /**
447
+ * @public
404
448
  * <p>Unvalidated JSON of a demodulation <code>Config</code>.</p>
405
449
  */
406
450
  unvalidatedJSON: string | undefined;
@@ -411,14 +455,17 @@ export interface DemodulationConfig {
411
455
  */
412
456
  export interface AntennaDownlinkDemodDecodeConfig {
413
457
  /**
458
+ * @public
414
459
  * <p>Information about the spectral <code>Config</code>.</p>
415
460
  */
416
461
  spectrumConfig: SpectrumConfig | undefined;
417
462
  /**
463
+ * @public
418
464
  * <p>Information about the demodulation <code>Config</code>.</p>
419
465
  */
420
466
  demodulationConfig: DemodulationConfig | undefined;
421
467
  /**
468
+ * @public
422
469
  * <p>Information about the decode <code>Config</code>.</p>
423
470
  */
424
471
  decodeConfig: DecodeConfig | undefined;
@@ -429,10 +476,12 @@ export interface AntennaDownlinkDemodDecodeConfig {
429
476
  */
430
477
  export interface UplinkSpectrumConfig {
431
478
  /**
479
+ * @public
432
480
  * <p>Center frequency of an uplink spectral <code>Config</code>. Valid values are between 2025 to 2120 MHz.</p>
433
481
  */
434
482
  centerFrequency: Frequency | undefined;
435
483
  /**
484
+ * @public
436
485
  * <p>Polarization of an uplink spectral <code>Config</code>. Capturing both <code>"RIGHT_HAND"</code> and <code>"LEFT_HAND"</code> polarization requires two separate configs.</p>
437
486
  */
438
487
  polarization?: Polarization | string;
@@ -454,10 +503,12 @@ export type EirpUnits = (typeof EirpUnits)[keyof typeof EirpUnits];
454
503
  */
455
504
  export interface Eirp {
456
505
  /**
506
+ * @public
457
507
  * <p>Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.</p>
458
508
  */
459
509
  value: number | undefined;
460
510
  /**
511
+ * @public
461
512
  * <p>Units of an EIRP.</p>
462
513
  */
463
514
  units: EirpUnits | string | undefined;
@@ -468,14 +519,17 @@ export interface Eirp {
468
519
  */
469
520
  export interface AntennaUplinkConfig {
470
521
  /**
522
+ * @public
471
523
  * <p>Whether or not uplink transmit is disabled.</p>
472
524
  */
473
525
  transmitDisabled?: boolean;
474
526
  /**
527
+ * @public
475
528
  * <p>Information about the uplink spectral <code>Config</code>.</p>
476
529
  */
477
530
  spectrumConfig: UplinkSpectrumConfig | undefined;
478
531
  /**
532
+ * @public
479
533
  * <p>EIRP of the target.</p>
480
534
  */
481
535
  targetEirp: Eirp | undefined;
@@ -498,10 +552,12 @@ export type AuditResults = (typeof AuditResults)[keyof typeof AuditResults];
498
552
  */
499
553
  export interface SocketAddress {
500
554
  /**
555
+ * @public
501
556
  * <p>Name of a socket address.</p>
502
557
  */
503
558
  name: string | undefined;
504
559
  /**
560
+ * @public
505
561
  * <p>Port of a socket address.</p>
506
562
  */
507
563
  port: number | undefined;
@@ -512,10 +568,12 @@ export interface SocketAddress {
512
568
  */
513
569
  export interface ConnectionDetails {
514
570
  /**
571
+ * @public
515
572
  * <p>A socket address.</p>
516
573
  */
517
574
  socketAddress: SocketAddress | undefined;
518
575
  /**
576
+ * @public
519
577
  * <p>Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.</p>
520
578
  */
521
579
  mtu?: number;
@@ -526,10 +584,12 @@ export interface ConnectionDetails {
526
584
  */
527
585
  export interface IntegerRange {
528
586
  /**
587
+ * @public
529
588
  * <p>A minimum value.</p>
530
589
  */
531
590
  minimum: number | undefined;
532
591
  /**
592
+ * @public
533
593
  * <p>A maximum value.</p>
534
594
  */
535
595
  maximum: number | undefined;
@@ -540,10 +600,12 @@ export interface IntegerRange {
540
600
  */
541
601
  export interface RangedSocketAddress {
542
602
  /**
603
+ * @public
543
604
  * <p>IPv4 socket address.</p>
544
605
  */
545
606
  name: string | undefined;
546
607
  /**
608
+ * @public
547
609
  * <p>Port range of a socket address.</p>
548
610
  */
549
611
  portRange: IntegerRange | undefined;
@@ -554,10 +616,12 @@ export interface RangedSocketAddress {
554
616
  */
555
617
  export interface RangedConnectionDetails {
556
618
  /**
619
+ * @public
557
620
  * <p>A ranged socket address.</p>
558
621
  */
559
622
  socketAddress: RangedSocketAddress | undefined;
560
623
  /**
624
+ * @public
561
625
  * <p>Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.</p>
562
626
  */
563
627
  mtu?: number;
@@ -568,22 +632,27 @@ export interface RangedConnectionDetails {
568
632
  */
569
633
  export interface AwsGroundStationAgentEndpoint {
570
634
  /**
635
+ * @public
571
636
  * <p>Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.</p>
572
637
  */
573
638
  name: string | undefined;
574
639
  /**
640
+ * @public
575
641
  * <p>The egress address of AgentEndpoint.</p>
576
642
  */
577
643
  egressAddress: ConnectionDetails | undefined;
578
644
  /**
645
+ * @public
579
646
  * <p>The ingress address of AgentEndpoint.</p>
580
647
  */
581
648
  ingressAddress: RangedConnectionDetails | undefined;
582
649
  /**
650
+ * @public
583
651
  * <p>The status of AgentEndpoint.</p>
584
652
  */
585
653
  agentStatus?: AgentStatus | string;
586
654
  /**
655
+ * @public
587
656
  * <p>The results of the audit.</p>
588
657
  */
589
658
  auditResults?: AuditResults | string;
@@ -594,6 +663,7 @@ export interface AwsGroundStationAgentEndpoint {
594
663
  */
595
664
  export interface CancelContactRequest {
596
665
  /**
666
+ * @public
597
667
  * <p>UUID of a contact.</p>
598
668
  */
599
669
  contactId: string | undefined;
@@ -604,6 +674,7 @@ export interface CancelContactRequest {
604
674
  */
605
675
  export interface ContactIdResponse {
606
676
  /**
677
+ * @public
607
678
  * <p>UUID of a contact.</p>
608
679
  */
609
680
  contactId?: string;
@@ -660,14 +731,17 @@ export type ConfigCapabilityType = (typeof ConfigCapabilityType)[keyof typeof Co
660
731
  */
661
732
  export interface ConfigIdResponse {
662
733
  /**
734
+ * @public
663
735
  * <p>UUID of a <code>Config</code>.</p>
664
736
  */
665
737
  configId?: string;
666
738
  /**
739
+ * @public
667
740
  * <p>Type of a <code>Config</code>.</p>
668
741
  */
669
742
  configType?: ConfigCapabilityType | string;
670
743
  /**
744
+ * @public
671
745
  * <p>ARN of a <code>Config</code>.</p>
672
746
  */
673
747
  configArn?: string;
@@ -678,10 +752,12 @@ export interface ConfigIdResponse {
678
752
  */
679
753
  export interface DataflowEndpointConfig {
680
754
  /**
755
+ * @public
681
756
  * <p>Name of a dataflow endpoint.</p>
682
757
  */
683
758
  dataflowEndpointName: string | undefined;
684
759
  /**
760
+ * @public
685
761
  * <p>Region of a dataflow endpoint.</p>
686
762
  */
687
763
  dataflowEndpointRegion?: string;
@@ -692,14 +768,17 @@ export interface DataflowEndpointConfig {
692
768
  */
693
769
  export interface S3RecordingConfig {
694
770
  /**
771
+ * @public
695
772
  * <p>ARN of the bucket to record to.</p>
696
773
  */
697
774
  bucketArn: string | undefined;
698
775
  /**
776
+ * @public
699
777
  * <p>ARN of the role Ground Station assumes to write data to the bucket.</p>
700
778
  */
701
779
  roleArn: string | undefined;
702
780
  /**
781
+ * @public
703
782
  * <p>S3 Key prefix to prefice data files.</p>
704
783
  */
705
784
  prefix?: string;
@@ -724,6 +803,7 @@ export type Criticality = (typeof Criticality)[keyof typeof Criticality];
724
803
  */
725
804
  export interface TrackingConfig {
726
805
  /**
806
+ * @public
727
807
  * <p>Current setting for autotrack.</p>
728
808
  */
729
809
  autotrack: Criticality | string | undefined;
@@ -737,10 +817,12 @@ export interface TrackingConfig {
737
817
  */
738
818
  export interface UplinkEchoConfig {
739
819
  /**
820
+ * @public
740
821
  * <p>Whether or not an uplink <code>Config</code> is enabled.</p>
741
822
  */
742
823
  enabled: boolean | undefined;
743
824
  /**
825
+ * @public
744
826
  * <p>ARN of an uplink <code>Config</code>.</p>
745
827
  */
746
828
  antennaUplinkConfigArn: string | undefined;
@@ -756,6 +838,7 @@ export type ConfigTypeData = ConfigTypeData.AntennaDownlinkConfigMember | Config
756
838
  */
757
839
  export declare namespace ConfigTypeData {
758
840
  /**
841
+ * @public
759
842
  * <p>Information about how AWS Ground Station should configure an antenna for downlink during a contact.</p>
760
843
  */
761
844
  interface AntennaDownlinkConfigMember {
@@ -769,6 +852,7 @@ export declare namespace ConfigTypeData {
769
852
  $unknown?: never;
770
853
  }
771
854
  /**
855
+ * @public
772
856
  * <p>Object that determines whether tracking should be used during a contact executed with this <code>Config</code> in the mission profile. </p>
773
857
  */
774
858
  interface TrackingConfigMember {
@@ -782,6 +866,7 @@ export declare namespace ConfigTypeData {
782
866
  $unknown?: never;
783
867
  }
784
868
  /**
869
+ * @public
785
870
  * <p>Information about the dataflow endpoint <code>Config</code>.</p>
786
871
  */
787
872
  interface DataflowEndpointConfigMember {
@@ -795,6 +880,7 @@ export declare namespace ConfigTypeData {
795
880
  $unknown?: never;
796
881
  }
797
882
  /**
883
+ * @public
798
884
  * <p>Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.</p>
799
885
  */
800
886
  interface AntennaDownlinkDemodDecodeConfigMember {
@@ -808,6 +894,7 @@ export declare namespace ConfigTypeData {
808
894
  $unknown?: never;
809
895
  }
810
896
  /**
897
+ * @public
811
898
  * <p>Information about how AWS Ground Station should configure an antenna for uplink during a contact.</p>
812
899
  */
813
900
  interface AntennaUplinkConfigMember {
@@ -821,6 +908,7 @@ export declare namespace ConfigTypeData {
821
908
  $unknown?: never;
822
909
  }
823
910
  /**
911
+ * @public
824
912
  * <p>Information about an uplink echo <code>Config</code>.</p>
825
913
  * <p>Parameters from the <code>AntennaUplinkConfig</code>, corresponding to the specified <code>AntennaUplinkConfigArn</code>, are used when this <code>UplinkEchoConfig</code> is used in a contact.</p>
826
914
  */
@@ -835,6 +923,7 @@ export declare namespace ConfigTypeData {
835
923
  $unknown?: never;
836
924
  }
837
925
  /**
926
+ * @public
838
927
  * <p>Information about an S3 recording <code>Config</code>.</p>
839
928
  */
840
929
  interface S3RecordingConfigMember {
@@ -847,6 +936,9 @@ export declare namespace ConfigTypeData {
847
936
  s3RecordingConfig: S3RecordingConfig;
848
937
  $unknown?: never;
849
938
  }
939
+ /**
940
+ * @public
941
+ */
850
942
  interface $UnknownMember {
851
943
  antennaDownlinkConfig?: never;
852
944
  trackingConfig?: never;
@@ -875,14 +967,17 @@ export declare namespace ConfigTypeData {
875
967
  */
876
968
  export interface CreateConfigRequest {
877
969
  /**
970
+ * @public
878
971
  * <p>Name of a <code>Config</code>.</p>
879
972
  */
880
973
  name: string | undefined;
881
974
  /**
975
+ * @public
882
976
  * <p>Parameters of a <code>Config</code>.</p>
883
977
  */
884
978
  configData: ConfigTypeData | undefined;
885
979
  /**
980
+ * @public
886
981
  * <p>Tags assigned to a <code>Config</code>.</p>
887
982
  */
888
983
  tags?: Record<string, string>;
@@ -895,6 +990,7 @@ export declare class ResourceLimitExceededException extends __BaseException {
895
990
  readonly name: "ResourceLimitExceededException";
896
991
  readonly $fault: "client";
897
992
  /**
993
+ * @public
898
994
  * <p/>
899
995
  */
900
996
  parameterName?: string;
@@ -909,10 +1005,12 @@ export declare class ResourceLimitExceededException extends __BaseException {
909
1005
  */
910
1006
  export interface DeleteConfigRequest {
911
1007
  /**
1008
+ * @public
912
1009
  * <p>UUID of a <code>Config</code>.</p>
913
1010
  */
914
1011
  configId: string | undefined;
915
1012
  /**
1013
+ * @public
916
1014
  * <p>Type of a <code>Config</code>.</p>
917
1015
  */
918
1016
  configType: ConfigCapabilityType | string | undefined;
@@ -923,10 +1021,12 @@ export interface DeleteConfigRequest {
923
1021
  */
924
1022
  export interface GetConfigRequest {
925
1023
  /**
1024
+ * @public
926
1025
  * <p>UUID of a <code>Config</code>.</p>
927
1026
  */
928
1027
  configId: string | undefined;
929
1028
  /**
1029
+ * @public
930
1030
  * <p>Type of a <code>Config</code>.</p>
931
1031
  */
932
1032
  configType: ConfigCapabilityType | string | undefined;
@@ -937,27 +1037,33 @@ export interface GetConfigRequest {
937
1037
  */
938
1038
  export interface GetConfigResponse {
939
1039
  /**
1040
+ * @public
940
1041
  * <p>UUID of a <code>Config</code>.</p>
941
1042
  */
942
1043
  configId: string | undefined;
943
1044
  /**
1045
+ * @public
944
1046
  * <p>ARN of a <code>Config</code>
945
1047
  * </p>
946
1048
  */
947
1049
  configArn: string | undefined;
948
1050
  /**
1051
+ * @public
949
1052
  * <p>Name of a <code>Config</code>.</p>
950
1053
  */
951
1054
  name: string | undefined;
952
1055
  /**
1056
+ * @public
953
1057
  * <p>Type of a <code>Config</code>.</p>
954
1058
  */
955
1059
  configType?: ConfigCapabilityType | string;
956
1060
  /**
1061
+ * @public
957
1062
  * <p>Data elements in a <code>Config</code>.</p>
958
1063
  */
959
1064
  configData: ConfigTypeData | undefined;
960
1065
  /**
1066
+ * @public
961
1067
  * <p>Tags assigned to a <code>Config</code>.</p>
962
1068
  */
963
1069
  tags?: Record<string, string>;
@@ -968,10 +1074,12 @@ export interface GetConfigResponse {
968
1074
  */
969
1075
  export interface ListConfigsRequest {
970
1076
  /**
1077
+ * @public
971
1078
  * <p>Maximum number of <code>Configs</code> returned.</p>
972
1079
  */
973
1080
  maxResults?: number;
974
1081
  /**
1082
+ * @public
975
1083
  * <p>Next token returned in the request of a previous <code>ListConfigs</code> call. Used to get the next page of results.</p>
976
1084
  */
977
1085
  nextToken?: string;
@@ -982,18 +1090,22 @@ export interface ListConfigsRequest {
982
1090
  */
983
1091
  export interface ConfigListItem {
984
1092
  /**
1093
+ * @public
985
1094
  * <p>UUID of a <code>Config</code>.</p>
986
1095
  */
987
1096
  configId?: string;
988
1097
  /**
1098
+ * @public
989
1099
  * <p>Type of a <code>Config</code>.</p>
990
1100
  */
991
1101
  configType?: ConfigCapabilityType | string;
992
1102
  /**
1103
+ * @public
993
1104
  * <p>ARN of a <code>Config</code>.</p>
994
1105
  */
995
1106
  configArn?: string;
996
1107
  /**
1108
+ * @public
997
1109
  * <p>Name of a <code>Config</code>.</p>
998
1110
  */
999
1111
  name?: string;
@@ -1004,10 +1116,12 @@ export interface ConfigListItem {
1004
1116
  */
1005
1117
  export interface ListConfigsResponse {
1006
1118
  /**
1119
+ * @public
1007
1120
  * <p>Next token returned in the response of a previous <code>ListConfigs</code> call. Used to get the next page of results.</p>
1008
1121
  */
1009
1122
  nextToken?: string;
1010
1123
  /**
1124
+ * @public
1011
1125
  * <p>List of <code>Config</code> items.</p>
1012
1126
  */
1013
1127
  configList?: ConfigListItem[];
@@ -1018,18 +1132,22 @@ export interface ListConfigsResponse {
1018
1132
  */
1019
1133
  export interface UpdateConfigRequest {
1020
1134
  /**
1135
+ * @public
1021
1136
  * <p>UUID of a <code>Config</code>.</p>
1022
1137
  */
1023
1138
  configId: string | undefined;
1024
1139
  /**
1140
+ * @public
1025
1141
  * <p>Name of a <code>Config</code>.</p>
1026
1142
  */
1027
1143
  name: string | undefined;
1028
1144
  /**
1145
+ * @public
1029
1146
  * <p>Type of a <code>Config</code>.</p>
1030
1147
  */
1031
1148
  configType: ConfigCapabilityType | string | undefined;
1032
1149
  /**
1150
+ * @public
1033
1151
  * <p>Parameters of a <code>Config</code>.</p>
1034
1152
  */
1035
1153
  configData: ConfigTypeData | undefined;
@@ -1055,18 +1173,22 @@ export type EndpointStatus = (typeof EndpointStatus)[keyof typeof EndpointStatus
1055
1173
  */
1056
1174
  export interface DataflowEndpoint {
1057
1175
  /**
1176
+ * @public
1058
1177
  * <p>Name of a dataflow endpoint.</p>
1059
1178
  */
1060
1179
  name?: string;
1061
1180
  /**
1181
+ * @public
1062
1182
  * <p>Socket address of a dataflow endpoint.</p>
1063
1183
  */
1064
1184
  address?: SocketAddress;
1065
1185
  /**
1186
+ * @public
1066
1187
  * <p>Status of a dataflow endpoint.</p>
1067
1188
  */
1068
1189
  status?: EndpointStatus | string;
1069
1190
  /**
1191
+ * @public
1070
1192
  * <p>Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.</p>
1071
1193
  */
1072
1194
  mtu?: number;
@@ -1077,14 +1199,17 @@ export interface DataflowEndpoint {
1077
1199
  */
1078
1200
  export interface SecurityDetails {
1079
1201
  /**
1202
+ * @public
1080
1203
  * <p>A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.</p>
1081
1204
  */
1082
1205
  subnetIds: string[] | undefined;
1083
1206
  /**
1207
+ * @public
1084
1208
  * <p>The security groups to attach to the elastic network interfaces.</p>
1085
1209
  */
1086
1210
  securityGroupIds: string[] | undefined;
1087
1211
  /**
1212
+ * @public
1088
1213
  * <p>ARN to a role needed for connecting streams to your instances. </p>
1089
1214
  */
1090
1215
  roleArn: string | undefined;
@@ -1095,22 +1220,27 @@ export interface SecurityDetails {
1095
1220
  */
1096
1221
  export interface EndpointDetails {
1097
1222
  /**
1223
+ * @public
1098
1224
  * <p>Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.</p>
1099
1225
  */
1100
1226
  securityDetails?: SecurityDetails;
1101
1227
  /**
1228
+ * @public
1102
1229
  * <p>A dataflow endpoint.</p>
1103
1230
  */
1104
1231
  endpoint?: DataflowEndpoint;
1105
1232
  /**
1233
+ * @public
1106
1234
  * <p>An agent endpoint.</p>
1107
1235
  */
1108
1236
  awsGroundStationAgentEndpoint?: AwsGroundStationAgentEndpoint;
1109
1237
  /**
1238
+ * @public
1110
1239
  * <p>A dataflow endpoint health status. This field is ignored when calling <code>CreateDataflowEndpointGroup</code>.</p>
1111
1240
  */
1112
1241
  healthStatus?: CapabilityHealth | string;
1113
1242
  /**
1243
+ * @public
1114
1244
  * <p>Health reasons for a dataflow endpoint. This field is ignored when calling <code>CreateDataflowEndpointGroup</code>.</p>
1115
1245
  */
1116
1246
  healthReasons?: (CapabilityHealthReason | string)[];
@@ -1121,10 +1251,12 @@ export interface EndpointDetails {
1121
1251
  */
1122
1252
  export interface S3RecordingDetails {
1123
1253
  /**
1254
+ * @public
1124
1255
  * <p>ARN of the bucket used.</p>
1125
1256
  */
1126
1257
  bucketArn?: string;
1127
1258
  /**
1259
+ * @public
1128
1260
  * <p>Key template used for the S3 Recording Configuration</p>
1129
1261
  */
1130
1262
  keyTemplate?: string;
@@ -1139,6 +1271,7 @@ export type ConfigDetails = ConfigDetails.AntennaDemodDecodeDetailsMember | Conf
1139
1271
  */
1140
1272
  export declare namespace ConfigDetails {
1141
1273
  /**
1274
+ * @public
1142
1275
  * <p>Information about the endpoint details.</p>
1143
1276
  */
1144
1277
  interface EndpointDetailsMember {
@@ -1148,6 +1281,7 @@ export declare namespace ConfigDetails {
1148
1281
  $unknown?: never;
1149
1282
  }
1150
1283
  /**
1284
+ * @public
1151
1285
  * <p>Details for antenna demod decode <code>Config</code> in a contact.</p>
1152
1286
  */
1153
1287
  interface AntennaDemodDecodeDetailsMember {
@@ -1157,6 +1291,7 @@ export declare namespace ConfigDetails {
1157
1291
  $unknown?: never;
1158
1292
  }
1159
1293
  /**
1294
+ * @public
1160
1295
  * <p>Details for an S3 recording <code>Config</code> in a contact.</p>
1161
1296
  */
1162
1297
  interface S3RecordingDetailsMember {
@@ -1165,6 +1300,9 @@ export declare namespace ConfigDetails {
1165
1300
  s3RecordingDetails: S3RecordingDetails;
1166
1301
  $unknown?: never;
1167
1302
  }
1303
+ /**
1304
+ * @public
1305
+ */
1168
1306
  interface $UnknownMember {
1169
1307
  endpointDetails?: never;
1170
1308
  antennaDemodDecodeDetails?: never;
@@ -1185,6 +1323,7 @@ export declare namespace ConfigDetails {
1185
1323
  */
1186
1324
  export interface DescribeContactRequest {
1187
1325
  /**
1326
+ * @public
1188
1327
  * <p>UUID of a contact.</p>
1189
1328
  */
1190
1329
  contactId: string | undefined;
@@ -1218,18 +1357,22 @@ export type ContactStatus = (typeof ContactStatus)[keyof typeof ContactStatus];
1218
1357
  */
1219
1358
  export interface Destination {
1220
1359
  /**
1360
+ * @public
1221
1361
  * <p>Type of a <code>Config</code>.</p>
1222
1362
  */
1223
1363
  configType?: ConfigCapabilityType | string;
1224
1364
  /**
1365
+ * @public
1225
1366
  * <p>UUID of a <code>Config</code>.</p>
1226
1367
  */
1227
1368
  configId?: string;
1228
1369
  /**
1370
+ * @public
1229
1371
  * <p>Additional details for a <code>Config</code>, if type is dataflow endpoint or antenna demod decode.</p>
1230
1372
  */
1231
1373
  configDetails?: ConfigDetails;
1232
1374
  /**
1375
+ * @public
1233
1376
  * <p>Region of a dataflow destination.</p>
1234
1377
  */
1235
1378
  dataflowDestinationRegion?: string;
@@ -1240,19 +1383,23 @@ export interface Destination {
1240
1383
  */
1241
1384
  export interface Source {
1242
1385
  /**
1386
+ * @public
1243
1387
  * <p>Type of a <code>Config</code>.</p>
1244
1388
  */
1245
1389
  configType?: ConfigCapabilityType | string;
1246
1390
  /**
1391
+ * @public
1247
1392
  * <p>UUID of a <code>Config</code>.</p>
1248
1393
  */
1249
1394
  configId?: string;
1250
1395
  /**
1396
+ * @public
1251
1397
  * <p>Additional details for a <code>Config</code>, if type is <code>dataflow-endpoint</code> or <code>antenna-downlink-demod-decode</code>
1252
1398
  * </p>
1253
1399
  */
1254
1400
  configDetails?: ConfigDetails;
1255
1401
  /**
1402
+ * @public
1256
1403
  * <p>Region of a dataflow source.</p>
1257
1404
  */
1258
1405
  dataflowSourceRegion?: string;
@@ -1263,14 +1410,17 @@ export interface Source {
1263
1410
  */
1264
1411
  export interface DataflowDetail {
1265
1412
  /**
1413
+ * @public
1266
1414
  * <p>Dataflow details for the source side.</p>
1267
1415
  */
1268
1416
  source?: Source;
1269
1417
  /**
1418
+ * @public
1270
1419
  * <p>Dataflow details for the destination side.</p>
1271
1420
  */
1272
1421
  destination?: Destination;
1273
1422
  /**
1423
+ * @public
1274
1424
  * <p>Error message for a dataflow.</p>
1275
1425
  */
1276
1426
  errorMessage?: string;
@@ -1281,10 +1431,12 @@ export interface DataflowDetail {
1281
1431
  */
1282
1432
  export interface Elevation {
1283
1433
  /**
1434
+ * @public
1284
1435
  * <p>Elevation angle value.</p>
1285
1436
  */
1286
1437
  value: number | undefined;
1287
1438
  /**
1439
+ * @public
1288
1440
  * <p>Elevation angle units.</p>
1289
1441
  */
1290
1442
  unit: AngleUnits | string | undefined;
@@ -1295,58 +1447,72 @@ export interface Elevation {
1295
1447
  */
1296
1448
  export interface DescribeContactResponse {
1297
1449
  /**
1450
+ * @public
1298
1451
  * <p>UUID of a contact.</p>
1299
1452
  */
1300
1453
  contactId?: string;
1301
1454
  /**
1455
+ * @public
1302
1456
  * <p>ARN of a mission profile.</p>
1303
1457
  */
1304
1458
  missionProfileArn?: string;
1305
1459
  /**
1460
+ * @public
1306
1461
  * <p>ARN of a satellite.</p>
1307
1462
  */
1308
1463
  satelliteArn?: string;
1309
1464
  /**
1465
+ * @public
1310
1466
  * <p>Start time of a contact in UTC.</p>
1311
1467
  */
1312
1468
  startTime?: Date;
1313
1469
  /**
1470
+ * @public
1314
1471
  * <p>End time of a contact in UTC.</p>
1315
1472
  */
1316
1473
  endTime?: Date;
1317
1474
  /**
1475
+ * @public
1318
1476
  * <p>Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.</p>
1319
1477
  */
1320
1478
  prePassStartTime?: Date;
1321
1479
  /**
1480
+ * @public
1322
1481
  * <p>Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.</p>
1323
1482
  */
1324
1483
  postPassEndTime?: Date;
1325
1484
  /**
1485
+ * @public
1326
1486
  * <p>Ground station for a contact.</p>
1327
1487
  */
1328
1488
  groundStation?: string;
1329
1489
  /**
1490
+ * @public
1330
1491
  * <p>Status of a contact.</p>
1331
1492
  */
1332
1493
  contactStatus?: ContactStatus | string;
1333
1494
  /**
1495
+ * @public
1334
1496
  * <p>Error message for a contact.</p>
1335
1497
  */
1336
1498
  errorMessage?: string;
1337
1499
  /**
1500
+ * @public
1338
1501
  * <p>Maximum elevation angle of a contact.</p>
1339
1502
  */
1340
1503
  maximumElevation?: Elevation;
1341
1504
  /**
1505
+ * @public
1342
1506
  * <p>Tags assigned to a contact.</p>
1343
1507
  */
1344
1508
  tags?: Record<string, string>;
1345
1509
  /**
1510
+ * @public
1346
1511
  * <p>Region of a contact.</p>
1347
1512
  */
1348
1513
  region?: string;
1349
1514
  /**
1515
+ * @public
1350
1516
  * <p>List describing source and destination details for each dataflow edge.</p>
1351
1517
  */
1352
1518
  dataflowList?: DataflowDetail[];
@@ -1357,34 +1523,42 @@ export interface DescribeContactResponse {
1357
1523
  */
1358
1524
  export interface ListContactsRequest {
1359
1525
  /**
1526
+ * @public
1360
1527
  * <p>Maximum number of contacts returned.</p>
1361
1528
  */
1362
1529
  maxResults?: number;
1363
1530
  /**
1531
+ * @public
1364
1532
  * <p>Next token returned in the request of a previous <code>ListContacts</code> call. Used to get the next page of results.</p>
1365
1533
  */
1366
1534
  nextToken?: string;
1367
1535
  /**
1536
+ * @public
1368
1537
  * <p>Status of a contact reservation.</p>
1369
1538
  */
1370
1539
  statusList: (ContactStatus | string)[] | undefined;
1371
1540
  /**
1541
+ * @public
1372
1542
  * <p>Start time of a contact in UTC.</p>
1373
1543
  */
1374
1544
  startTime: Date | undefined;
1375
1545
  /**
1546
+ * @public
1376
1547
  * <p>End time of a contact in UTC.</p>
1377
1548
  */
1378
1549
  endTime: Date | undefined;
1379
1550
  /**
1551
+ * @public
1380
1552
  * <p>Name of a ground station.</p>
1381
1553
  */
1382
1554
  groundStation?: string;
1383
1555
  /**
1556
+ * @public
1384
1557
  * <p>ARN of a satellite.</p>
1385
1558
  */
1386
1559
  satelliteArn?: string;
1387
1560
  /**
1561
+ * @public
1388
1562
  * <p>ARN of a mission profile.</p>
1389
1563
  */
1390
1564
  missionProfileArn?: string;
@@ -1395,54 +1569,67 @@ export interface ListContactsRequest {
1395
1569
  */
1396
1570
  export interface ContactData {
1397
1571
  /**
1572
+ * @public
1398
1573
  * <p>UUID of a contact.</p>
1399
1574
  */
1400
1575
  contactId?: string;
1401
1576
  /**
1577
+ * @public
1402
1578
  * <p>ARN of a mission profile.</p>
1403
1579
  */
1404
1580
  missionProfileArn?: string;
1405
1581
  /**
1582
+ * @public
1406
1583
  * <p>ARN of a satellite.</p>
1407
1584
  */
1408
1585
  satelliteArn?: string;
1409
1586
  /**
1587
+ * @public
1410
1588
  * <p>Start time of a contact in UTC.</p>
1411
1589
  */
1412
1590
  startTime?: Date;
1413
1591
  /**
1592
+ * @public
1414
1593
  * <p>End time of a contact in UTC.</p>
1415
1594
  */
1416
1595
  endTime?: Date;
1417
1596
  /**
1597
+ * @public
1418
1598
  * <p>Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.</p>
1419
1599
  */
1420
1600
  prePassStartTime?: Date;
1421
1601
  /**
1602
+ * @public
1422
1603
  * <p>Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.</p>
1423
1604
  */
1424
1605
  postPassEndTime?: Date;
1425
1606
  /**
1607
+ * @public
1426
1608
  * <p>Name of a ground station.</p>
1427
1609
  */
1428
1610
  groundStation?: string;
1429
1611
  /**
1612
+ * @public
1430
1613
  * <p>Status of a contact.</p>
1431
1614
  */
1432
1615
  contactStatus?: ContactStatus | string;
1433
1616
  /**
1617
+ * @public
1434
1618
  * <p>Error message of a contact.</p>
1435
1619
  */
1436
1620
  errorMessage?: string;
1437
1621
  /**
1622
+ * @public
1438
1623
  * <p>Maximum elevation angle of a contact.</p>
1439
1624
  */
1440
1625
  maximumElevation?: Elevation;
1441
1626
  /**
1627
+ * @public
1442
1628
  * <p>Region of a contact.</p>
1443
1629
  */
1444
1630
  region?: string;
1445
1631
  /**
1632
+ * @public
1446
1633
  * <p>Tags assigned to a contact.</p>
1447
1634
  */
1448
1635
  tags?: Record<string, string>;
@@ -1453,10 +1640,12 @@ export interface ContactData {
1453
1640
  */
1454
1641
  export interface ListContactsResponse {
1455
1642
  /**
1643
+ * @public
1456
1644
  * <p>Next token returned in the response of a previous <code>ListContacts</code> call. Used to get the next page of results.</p>
1457
1645
  */
1458
1646
  nextToken?: string;
1459
1647
  /**
1648
+ * @public
1460
1649
  * <p>List of contacts.</p>
1461
1650
  */
1462
1651
  contactList?: ContactData[];
@@ -1467,26 +1656,32 @@ export interface ListContactsResponse {
1467
1656
  */
1468
1657
  export interface ReserveContactRequest {
1469
1658
  /**
1659
+ * @public
1470
1660
  * <p>ARN of a mission profile.</p>
1471
1661
  */
1472
1662
  missionProfileArn: string | undefined;
1473
1663
  /**
1664
+ * @public
1474
1665
  * <p>ARN of a satellite</p>
1475
1666
  */
1476
1667
  satelliteArn: string | undefined;
1477
1668
  /**
1669
+ * @public
1478
1670
  * <p>Start time of a contact in UTC.</p>
1479
1671
  */
1480
1672
  startTime: Date | undefined;
1481
1673
  /**
1674
+ * @public
1482
1675
  * <p>End time of a contact in UTC.</p>
1483
1676
  */
1484
1677
  endTime: Date | undefined;
1485
1678
  /**
1679
+ * @public
1486
1680
  * <p>Name of a ground station.</p>
1487
1681
  */
1488
1682
  groundStation: string | undefined;
1489
1683
  /**
1684
+ * @public
1490
1685
  * <p>Tags assigned to a contact.</p>
1491
1686
  */
1492
1687
  tags?: Record<string, string>;
@@ -1497,18 +1692,22 @@ export interface ReserveContactRequest {
1497
1692
  */
1498
1693
  export interface CreateDataflowEndpointGroupRequest {
1499
1694
  /**
1695
+ * @public
1500
1696
  * <p>Endpoint details of each endpoint in the dataflow endpoint group.</p>
1501
1697
  */
1502
1698
  endpointDetails: EndpointDetails[] | undefined;
1503
1699
  /**
1700
+ * @public
1504
1701
  * <p>Tags of a dataflow endpoint group.</p>
1505
1702
  */
1506
1703
  tags?: Record<string, string>;
1507
1704
  /**
1705
+ * @public
1508
1706
  * <p>Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a <code>PREPASS</code> state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the <code>PREPASS</code> state.</p>
1509
1707
  */
1510
1708
  contactPrePassDurationSeconds?: number;
1511
1709
  /**
1710
+ * @public
1512
1711
  * <p>Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a <code>POSTPASS</code> state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the <code>POSTPASS</code> state.</p>
1513
1712
  */
1514
1713
  contactPostPassDurationSeconds?: number;
@@ -1519,6 +1718,7 @@ export interface CreateDataflowEndpointGroupRequest {
1519
1718
  */
1520
1719
  export interface DataflowEndpointGroupIdResponse {
1521
1720
  /**
1721
+ * @public
1522
1722
  * <p>UUID of a dataflow endpoint group.</p>
1523
1723
  */
1524
1724
  dataflowEndpointGroupId?: string;
@@ -1529,14 +1729,17 @@ export interface DataflowEndpointGroupIdResponse {
1529
1729
  */
1530
1730
  export interface S3Object {
1531
1731
  /**
1732
+ * @public
1532
1733
  * <p>An Amazon S3 Bucket name.</p>
1533
1734
  */
1534
1735
  bucket?: string;
1535
1736
  /**
1737
+ * @public
1536
1738
  * <p>An Amazon S3 key for the ephemeris.</p>
1537
1739
  */
1538
1740
  key?: string;
1539
1741
  /**
1742
+ * @public
1540
1743
  * <p>For versioned S3 objects, the version to use for the ephemeris.</p>
1541
1744
  */
1542
1745
  version?: string;
@@ -1547,10 +1750,12 @@ export interface S3Object {
1547
1750
  */
1548
1751
  export interface OEMEphemeris {
1549
1752
  /**
1753
+ * @public
1550
1754
  * <p>Identifies the S3 object to be used as the ephemeris.</p>
1551
1755
  */
1552
1756
  s3Object?: S3Object;
1553
1757
  /**
1758
+ * @public
1554
1759
  * <p>The data for an OEM ephemeris, supplied directly in the request rather than through an S3 object.</p>
1555
1760
  */
1556
1761
  oemData?: string;
@@ -1561,10 +1766,12 @@ export interface OEMEphemeris {
1561
1766
  */
1562
1767
  export interface TimeRange {
1563
1768
  /**
1769
+ * @public
1564
1770
  * <p>Time in UTC at which the time range starts.</p>
1565
1771
  */
1566
1772
  startTime: Date | undefined;
1567
1773
  /**
1774
+ * @public
1568
1775
  * <p>Time in UTC at which the time range ends.</p>
1569
1776
  */
1570
1777
  endTime: Date | undefined;
@@ -1575,14 +1782,17 @@ export interface TimeRange {
1575
1782
  */
1576
1783
  export interface TLEData {
1577
1784
  /**
1785
+ * @public
1578
1786
  * <p>First line of two-line element set (TLE) data.</p>
1579
1787
  */
1580
1788
  tleLine1: string | undefined;
1581
1789
  /**
1790
+ * @public
1582
1791
  * <p>Second line of two-line element set (TLE) data.</p>
1583
1792
  */
1584
1793
  tleLine2: string | undefined;
1585
1794
  /**
1795
+ * @public
1586
1796
  * <p>The valid time range for the TLE. Gaps or overlap are not permitted.</p>
1587
1797
  */
1588
1798
  validTimeRange: TimeRange | undefined;
@@ -1593,10 +1803,12 @@ export interface TLEData {
1593
1803
  */
1594
1804
  export interface TLEEphemeris {
1595
1805
  /**
1806
+ * @public
1596
1807
  * <p>Identifies the S3 object to be used as the ephemeris.</p>
1597
1808
  */
1598
1809
  s3Object?: S3Object;
1599
1810
  /**
1811
+ * @public
1600
1812
  * <p>The data for a TLE ephemeris, supplied directly in the request rather than through an S3 object.</p>
1601
1813
  */
1602
1814
  tleData?: TLEData[];
@@ -1611,6 +1823,7 @@ export type EphemerisData = EphemerisData.OemMember | EphemerisData.TleMember |
1611
1823
  */
1612
1824
  export declare namespace EphemerisData {
1613
1825
  /**
1826
+ * @public
1614
1827
  * <p>Two-line element set (TLE) ephemeris.</p>
1615
1828
  */
1616
1829
  interface TleMember {
@@ -1619,6 +1832,7 @@ export declare namespace EphemerisData {
1619
1832
  $unknown?: never;
1620
1833
  }
1621
1834
  /**
1835
+ * @public
1622
1836
  * <p>Ephemeris data in Orbit Ephemeris Message (OEM) format.</p>
1623
1837
  */
1624
1838
  interface OemMember {
@@ -1626,6 +1840,9 @@ export declare namespace EphemerisData {
1626
1840
  oem: OEMEphemeris;
1627
1841
  $unknown?: never;
1628
1842
  }
1843
+ /**
1844
+ * @public
1845
+ */
1629
1846
  interface $UnknownMember {
1630
1847
  tle?: never;
1631
1848
  oem?: never;
@@ -1643,37 +1860,45 @@ export declare namespace EphemerisData {
1643
1860
  */
1644
1861
  export interface CreateEphemerisRequest {
1645
1862
  /**
1863
+ * @public
1646
1864
  * <p>AWS Ground Station satellite ID for this ephemeris.</p>
1647
1865
  */
1648
1866
  satelliteId: string | undefined;
1649
1867
  /**
1868
+ * @public
1650
1869
  * <p>Whether to set the ephemeris status to <code>ENABLED</code> after validation.</p>
1651
1870
  * <p>Setting this to false will set the ephemeris status to <code>DISABLED</code> after validation.</p>
1652
1871
  */
1653
1872
  enabled?: boolean;
1654
1873
  /**
1874
+ * @public
1655
1875
  * <p>Customer-provided priority score to establish the order in which overlapping ephemerides should be used.</p>
1656
1876
  * <p>The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.</p>
1657
1877
  * <p>Priority must be 1 or greater</p>
1658
1878
  */
1659
1879
  priority?: number;
1660
1880
  /**
1881
+ * @public
1661
1882
  * <p>An overall expiration time for the ephemeris in UTC, after which it will become <code>EXPIRED</code>.</p>
1662
1883
  */
1663
1884
  expirationTime?: Date;
1664
1885
  /**
1886
+ * @public
1665
1887
  * <p>A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.</p>
1666
1888
  */
1667
1889
  name: string | undefined;
1668
1890
  /**
1891
+ * @public
1669
1892
  * <p>The ARN of a KMS key used to encrypt the ephemeris in Ground Station.</p>
1670
1893
  */
1671
1894
  kmsKeyArn?: string;
1672
1895
  /**
1896
+ * @public
1673
1897
  * <p>Ephemeris data.</p>
1674
1898
  */
1675
1899
  ephemeris?: EphemerisData;
1676
1900
  /**
1901
+ * @public
1677
1902
  * <p>Tags assigned to an ephemeris.</p>
1678
1903
  */
1679
1904
  tags?: Record<string, string>;
@@ -1683,6 +1908,7 @@ export interface CreateEphemerisRequest {
1683
1908
  */
1684
1909
  export interface EphemerisIdResponse {
1685
1910
  /**
1911
+ * @public
1686
1912
  * <p>The AWS Ground Station ephemeris ID.</p>
1687
1913
  */
1688
1914
  ephemerisId?: string;
@@ -1697,6 +1923,7 @@ export type KmsKey = KmsKey.KmsAliasArnMember | KmsKey.KmsKeyArnMember | KmsKey.
1697
1923
  */
1698
1924
  export declare namespace KmsKey {
1699
1925
  /**
1926
+ * @public
1700
1927
  * <p>KMS Key Arn.</p>
1701
1928
  */
1702
1929
  interface KmsKeyArnMember {
@@ -1705,6 +1932,7 @@ export declare namespace KmsKey {
1705
1932
  $unknown?: never;
1706
1933
  }
1707
1934
  /**
1935
+ * @public
1708
1936
  * <p>KMS Alias Arn.</p>
1709
1937
  */
1710
1938
  interface KmsAliasArnMember {
@@ -1712,6 +1940,9 @@ export declare namespace KmsKey {
1712
1940
  kmsAliasArn: string;
1713
1941
  $unknown?: never;
1714
1942
  }
1943
+ /**
1944
+ * @public
1945
+ */
1715
1946
  interface $UnknownMember {
1716
1947
  kmsKeyArn?: never;
1717
1948
  kmsAliasArn?: never;
@@ -1730,40 +1961,49 @@ export declare namespace KmsKey {
1730
1961
  */
1731
1962
  export interface CreateMissionProfileRequest {
1732
1963
  /**
1964
+ * @public
1733
1965
  * <p>Name of a mission profile.</p>
1734
1966
  */
1735
1967
  name: string | undefined;
1736
1968
  /**
1969
+ * @public
1737
1970
  * <p>Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.</p>
1738
1971
  */
1739
1972
  contactPrePassDurationSeconds?: number;
1740
1973
  /**
1974
+ * @public
1741
1975
  * <p>Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.</p>
1742
1976
  */
1743
1977
  contactPostPassDurationSeconds?: number;
1744
1978
  /**
1979
+ * @public
1745
1980
  * <p>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.</p>
1746
1981
  */
1747
1982
  minimumViableContactDurationSeconds: number | undefined;
1748
1983
  /**
1984
+ * @public
1749
1985
  * <p>A list of lists of ARNs. Each list of ARNs is an edge, with a <i>from</i>
1750
1986
  * <code>Config</code> and a <i>to</i>
1751
1987
  * <code>Config</code>.</p>
1752
1988
  */
1753
1989
  dataflowEdges: string[][] | undefined;
1754
1990
  /**
1991
+ * @public
1755
1992
  * <p>ARN of a tracking <code>Config</code>.</p>
1756
1993
  */
1757
1994
  trackingConfigArn: string | undefined;
1758
1995
  /**
1996
+ * @public
1759
1997
  * <p>Tags assigned to a mission profile.</p>
1760
1998
  */
1761
1999
  tags?: Record<string, string>;
1762
2000
  /**
2001
+ * @public
1763
2002
  * <p>KMS key to use for encrypting streams.</p>
1764
2003
  */
1765
2004
  streamsKmsKey?: KmsKey;
1766
2005
  /**
2006
+ * @public
1767
2007
  * <p>Role to use for encrypting streams with KMS key.</p>
1768
2008
  */
1769
2009
  streamsKmsRole?: string;
@@ -1774,6 +2014,7 @@ export interface CreateMissionProfileRequest {
1774
2014
  */
1775
2015
  export interface MissionProfileIdResponse {
1776
2016
  /**
2017
+ * @public
1777
2018
  * <p>UUID of a mission profile.</p>
1778
2019
  */
1779
2020
  missionProfileId?: string;
@@ -1784,6 +2025,7 @@ export interface MissionProfileIdResponse {
1784
2025
  */
1785
2026
  export interface DeleteDataflowEndpointGroupRequest {
1786
2027
  /**
2028
+ * @public
1787
2029
  * <p>UUID of a dataflow endpoint group.</p>
1788
2030
  */
1789
2031
  dataflowEndpointGroupId: string | undefined;
@@ -1794,6 +2036,7 @@ export interface DeleteDataflowEndpointGroupRequest {
1794
2036
  */
1795
2037
  export interface GetDataflowEndpointGroupRequest {
1796
2038
  /**
2039
+ * @public
1797
2040
  * <p>UUID of a dataflow endpoint group.</p>
1798
2041
  */
1799
2042
  dataflowEndpointGroupId: string | undefined;
@@ -1804,26 +2047,32 @@ export interface GetDataflowEndpointGroupRequest {
1804
2047
  */
1805
2048
  export interface GetDataflowEndpointGroupResponse {
1806
2049
  /**
2050
+ * @public
1807
2051
  * <p>UUID of a dataflow endpoint group.</p>
1808
2052
  */
1809
2053
  dataflowEndpointGroupId?: string;
1810
2054
  /**
2055
+ * @public
1811
2056
  * <p>ARN of a dataflow endpoint group.</p>
1812
2057
  */
1813
2058
  dataflowEndpointGroupArn?: string;
1814
2059
  /**
2060
+ * @public
1815
2061
  * <p>Details of a dataflow endpoint.</p>
1816
2062
  */
1817
2063
  endpointsDetails?: EndpointDetails[];
1818
2064
  /**
2065
+ * @public
1819
2066
  * <p>Tags assigned to a dataflow endpoint group.</p>
1820
2067
  */
1821
2068
  tags?: Record<string, string>;
1822
2069
  /**
2070
+ * @public
1823
2071
  * <p>Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a <code>PREPASS</code> state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the <code>PREPASS</code> state.</p>
1824
2072
  */
1825
2073
  contactPrePassDurationSeconds?: number;
1826
2074
  /**
2075
+ * @public
1827
2076
  * <p>Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a <code>POSTPASS</code> state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the <code>POSTPASS</code> state.</p>
1828
2077
  */
1829
2078
  contactPostPassDurationSeconds?: number;
@@ -1834,10 +2083,12 @@ export interface GetDataflowEndpointGroupResponse {
1834
2083
  */
1835
2084
  export interface ListDataflowEndpointGroupsRequest {
1836
2085
  /**
2086
+ * @public
1837
2087
  * <p>Maximum number of dataflow endpoint groups returned.</p>
1838
2088
  */
1839
2089
  maxResults?: number;
1840
2090
  /**
2091
+ * @public
1841
2092
  * <p>Next token returned in the request of a previous <code>ListDataflowEndpointGroups</code> call. Used to get the next page of results.</p>
1842
2093
  */
1843
2094
  nextToken?: string;
@@ -1848,10 +2099,12 @@ export interface ListDataflowEndpointGroupsRequest {
1848
2099
  */
1849
2100
  export interface DataflowEndpointListItem {
1850
2101
  /**
2102
+ * @public
1851
2103
  * <p>UUID of a dataflow endpoint group.</p>
1852
2104
  */
1853
2105
  dataflowEndpointGroupId?: string;
1854
2106
  /**
2107
+ * @public
1855
2108
  * <p>ARN of a dataflow endpoint group.</p>
1856
2109
  */
1857
2110
  dataflowEndpointGroupArn?: string;
@@ -1862,10 +2115,12 @@ export interface DataflowEndpointListItem {
1862
2115
  */
1863
2116
  export interface ListDataflowEndpointGroupsResponse {
1864
2117
  /**
2118
+ * @public
1865
2119
  * <p>Next token returned in the response of a previous <code>ListDataflowEndpointGroups</code> call. Used to get the next page of results.</p>
1866
2120
  */
1867
2121
  nextToken?: string;
1868
2122
  /**
2123
+ * @public
1869
2124
  * <p>A list of dataflow endpoint groups.</p>
1870
2125
  */
1871
2126
  dataflowEndpointGroupList?: DataflowEndpointListItem[];
@@ -1875,6 +2130,7 @@ export interface ListDataflowEndpointGroupsResponse {
1875
2130
  */
1876
2131
  export interface DeleteEphemerisRequest {
1877
2132
  /**
2133
+ * @public
1878
2134
  * <p>The AWS Ground Station ephemeris ID.</p>
1879
2135
  */
1880
2136
  ephemerisId: string | undefined;
@@ -1885,6 +2141,7 @@ export interface DeleteEphemerisRequest {
1885
2141
  */
1886
2142
  export interface DeleteMissionProfileRequest {
1887
2143
  /**
2144
+ * @public
1888
2145
  * <p>UUID of a mission profile.</p>
1889
2146
  */
1890
2147
  missionProfileId: string | undefined;
@@ -1894,6 +2151,7 @@ export interface DeleteMissionProfileRequest {
1894
2151
  */
1895
2152
  export interface DescribeEphemerisRequest {
1896
2153
  /**
2154
+ * @public
1897
2155
  * <p>The AWS Ground Station ephemeris ID.</p>
1898
2156
  */
1899
2157
  ephemerisId: string | undefined;
@@ -1950,10 +2208,12 @@ export type EphemerisStatus = (typeof EphemerisStatus)[keyof typeof EphemerisSta
1950
2208
  */
1951
2209
  export interface EphemerisDescription {
1952
2210
  /**
2211
+ * @public
1953
2212
  * <p>Source S3 object used for the ephemeris.</p>
1954
2213
  */
1955
2214
  sourceS3Object?: S3Object;
1956
2215
  /**
2216
+ * @public
1957
2217
  * <p>Supplied ephemeris data.</p>
1958
2218
  */
1959
2219
  ephemerisData?: string;
@@ -1968,6 +2228,7 @@ export type EphemerisTypeDescription = EphemerisTypeDescription.OemMember | Ephe
1968
2228
  */
1969
2229
  export declare namespace EphemerisTypeDescription {
1970
2230
  /**
2231
+ * @public
1971
2232
  * <p>Description of ephemeris.</p>
1972
2233
  */
1973
2234
  interface TleMember {
@@ -1976,6 +2237,7 @@ export declare namespace EphemerisTypeDescription {
1976
2237
  $unknown?: never;
1977
2238
  }
1978
2239
  /**
2240
+ * @public
1979
2241
  * <p>Description of ephemeris.</p>
1980
2242
  */
1981
2243
  interface OemMember {
@@ -1983,6 +2245,9 @@ export declare namespace EphemerisTypeDescription {
1983
2245
  oem: EphemerisDescription;
1984
2246
  $unknown?: never;
1985
2247
  }
2248
+ /**
2249
+ * @public
2250
+ */
1986
2251
  interface $UnknownMember {
1987
2252
  tle?: never;
1988
2253
  oem?: never;
@@ -2000,44 +2265,54 @@ export declare namespace EphemerisTypeDescription {
2000
2265
  */
2001
2266
  export interface DescribeEphemerisResponse {
2002
2267
  /**
2268
+ * @public
2003
2269
  * <p>The AWS Ground Station ephemeris ID.</p>
2004
2270
  */
2005
2271
  ephemerisId?: string;
2006
2272
  /**
2273
+ * @public
2007
2274
  * <p>The AWS Ground Station satellite ID associated with ephemeris.</p>
2008
2275
  */
2009
2276
  satelliteId?: string;
2010
2277
  /**
2278
+ * @public
2011
2279
  * <p>The status of the ephemeris.</p>
2012
2280
  */
2013
2281
  status?: EphemerisStatus | string;
2014
2282
  /**
2283
+ * @public
2015
2284
  * <p>Customer-provided priority score to establish the order in which overlapping ephemerides should be used.</p>
2016
2285
  * <p>The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.</p>
2017
2286
  * <p>Priority must be 1 or greater</p>
2018
2287
  */
2019
2288
  priority?: number;
2020
2289
  /**
2290
+ * @public
2021
2291
  * <p>The time the ephemeris was uploaded in UTC.</p>
2022
2292
  */
2023
2293
  creationTime?: Date;
2024
2294
  /**
2295
+ * @public
2025
2296
  * <p>Whether or not the ephemeris is enabled.</p>
2026
2297
  */
2027
2298
  enabled?: boolean;
2028
2299
  /**
2300
+ * @public
2029
2301
  * <p>A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.</p>
2030
2302
  */
2031
2303
  name?: string;
2032
2304
  /**
2305
+ * @public
2033
2306
  * <p>Tags assigned to an ephemeris.</p>
2034
2307
  */
2035
2308
  tags?: Record<string, string>;
2036
2309
  /**
2310
+ * @public
2037
2311
  * <p>Supplied ephemeris data.</p>
2038
2312
  */
2039
2313
  suppliedData?: EphemerisTypeDescription;
2040
2314
  /**
2315
+ * @public
2041
2316
  * <p>Reason that an ephemeris failed validation. Only provided for ephemerides with <code>INVALID</code> status.</p>
2042
2317
  */
2043
2318
  invalidReason?: EphemerisInvalidReason | string;
@@ -2048,32 +2323,39 @@ export interface DescribeEphemerisResponse {
2048
2323
  */
2049
2324
  export interface EphemerisItem {
2050
2325
  /**
2326
+ * @public
2051
2327
  * <p>The AWS Ground Station ephemeris ID.</p>
2052
2328
  */
2053
2329
  ephemerisId?: string;
2054
2330
  /**
2331
+ * @public
2055
2332
  * <p>The status of the ephemeris.</p>
2056
2333
  */
2057
2334
  status?: EphemerisStatus | string;
2058
2335
  /**
2336
+ * @public
2059
2337
  * <p>Customer-provided priority score to establish the order in which overlapping ephemerides should be used.</p>
2060
2338
  * <p>The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.</p>
2061
2339
  * <p>Priority must be 1 or greater</p>
2062
2340
  */
2063
2341
  priority?: number;
2064
2342
  /**
2343
+ * @public
2065
2344
  * <p>Whether or not the ephemeris is enabled.</p>
2066
2345
  */
2067
2346
  enabled?: boolean;
2068
2347
  /**
2348
+ * @public
2069
2349
  * <p>The time the ephemeris was uploaded in UTC.</p>
2070
2350
  */
2071
2351
  creationTime?: Date;
2072
2352
  /**
2353
+ * @public
2073
2354
  * <p>A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.</p>
2074
2355
  */
2075
2356
  name?: string;
2076
2357
  /**
2358
+ * @public
2077
2359
  * <p>Source S3 object used for the ephemeris.</p>
2078
2360
  */
2079
2361
  sourceS3Object?: S3Object;
@@ -2083,26 +2365,32 @@ export interface EphemerisItem {
2083
2365
  */
2084
2366
  export interface ListEphemeridesRequest {
2085
2367
  /**
2368
+ * @public
2086
2369
  * <p>The AWS Ground Station satellite ID to list ephemeris for.</p>
2087
2370
  */
2088
2371
  satelliteId: string | undefined;
2089
2372
  /**
2373
+ * @public
2090
2374
  * <p>The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the <code>startTime</code> and <code>endTime</code>.</p>
2091
2375
  */
2092
2376
  startTime: Date | undefined;
2093
2377
  /**
2378
+ * @public
2094
2379
  * <p>The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the <code>startTime</code> and <code>endTime</code>.</p>
2095
2380
  */
2096
2381
  endTime: Date | undefined;
2097
2382
  /**
2383
+ * @public
2098
2384
  * <p>The list of ephemeris status to return.</p>
2099
2385
  */
2100
2386
  statusList?: (EphemerisStatus | string)[];
2101
2387
  /**
2388
+ * @public
2102
2389
  * <p>Maximum number of ephemerides to return.</p>
2103
2390
  */
2104
2391
  maxResults?: number;
2105
2392
  /**
2393
+ * @public
2106
2394
  * <p>Pagination token.</p>
2107
2395
  */
2108
2396
  nextToken?: string;
@@ -2112,10 +2400,12 @@ export interface ListEphemeridesRequest {
2112
2400
  */
2113
2401
  export interface ListEphemeridesResponse {
2114
2402
  /**
2403
+ * @public
2115
2404
  * <p>Pagination token.</p>
2116
2405
  */
2117
2406
  nextToken?: string;
2118
2407
  /**
2408
+ * @public
2119
2409
  * <p>List of ephemerides.</p>
2120
2410
  */
2121
2411
  ephemerides?: EphemerisItem[];
@@ -2125,18 +2415,22 @@ export interface ListEphemeridesResponse {
2125
2415
  */
2126
2416
  export interface UpdateEphemerisRequest {
2127
2417
  /**
2418
+ * @public
2128
2419
  * <p>The AWS Ground Station ephemeris ID.</p>
2129
2420
  */
2130
2421
  ephemerisId: string | undefined;
2131
2422
  /**
2423
+ * @public
2132
2424
  * <p>Whether the ephemeris is enabled or not. Changing this value will not require the ephemeris to be re-validated.</p>
2133
2425
  */
2134
2426
  enabled: boolean | undefined;
2135
2427
  /**
2428
+ * @public
2136
2429
  * <p>A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.</p>
2137
2430
  */
2138
2431
  name?: string;
2139
2432
  /**
2433
+ * @public
2140
2434
  * <p>Customer-provided priority score to establish the order in which overlapping ephemerides should be used.</p>
2141
2435
  * <p>The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.</p>
2142
2436
  * <p>Priority must be 1 or greater</p>
@@ -2161,20 +2455,24 @@ export type EphemerisSource = (typeof EphemerisSource)[keyof typeof EphemerisSou
2161
2455
  */
2162
2456
  export interface EphemerisMetaData {
2163
2457
  /**
2458
+ * @public
2164
2459
  * <p>The <code>EphemerisSource</code> that generated a given ephemeris.</p>
2165
2460
  */
2166
2461
  source: EphemerisSource | string | undefined;
2167
2462
  /**
2463
+ * @public
2168
2464
  * <p>UUID of a customer-provided ephemeris.</p>
2169
2465
  * <p>This field is not populated for default ephemerides from Space Track.</p>
2170
2466
  */
2171
2467
  ephemerisId?: string;
2172
2468
  /**
2469
+ * @public
2173
2470
  * <p>The epoch of a default, ephemeris from Space Track in UTC.</p>
2174
2471
  * <p>This field is not populated for customer-provided ephemerides.</p>
2175
2472
  */
2176
2473
  epoch?: Date;
2177
2474
  /**
2475
+ * @public
2178
2476
  * <p>A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.</p>
2179
2477
  * <p>A name is only returned for customer-provider ephemerides that have a name associated.</p>
2180
2478
  */
@@ -2186,10 +2484,12 @@ export interface EphemerisMetaData {
2186
2484
  */
2187
2485
  export interface GetMinuteUsageRequest {
2188
2486
  /**
2487
+ * @public
2189
2488
  * <p>The month being requested, with a value of 1-12.</p>
2190
2489
  */
2191
2490
  month: number | undefined;
2192
2491
  /**
2492
+ * @public
2193
2493
  * <p>The year being requested, in the format of YYYY.</p>
2194
2494
  */
2195
2495
  year: number | undefined;
@@ -2200,22 +2500,27 @@ export interface GetMinuteUsageRequest {
2200
2500
  */
2201
2501
  export interface GetMinuteUsageResponse {
2202
2502
  /**
2503
+ * @public
2203
2504
  * <p>Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.</p>
2204
2505
  */
2205
2506
  isReservedMinutesCustomer?: boolean;
2206
2507
  /**
2508
+ * @public
2207
2509
  * <p>Total number of reserved minutes allocated, specific to the month being requested.</p>
2208
2510
  */
2209
2511
  totalReservedMinuteAllocation?: number;
2210
2512
  /**
2513
+ * @public
2211
2514
  * <p>Upcoming minutes scheduled for an account, specific to the month being requested.</p>
2212
2515
  */
2213
2516
  upcomingMinutesScheduled?: number;
2214
2517
  /**
2518
+ * @public
2215
2519
  * <p>Total scheduled minutes for an account, specific to the month being requested.</p>
2216
2520
  */
2217
2521
  totalScheduledMinutes?: number;
2218
2522
  /**
2523
+ * @public
2219
2524
  * <p>Estimated number of minutes remaining for an account, specific to the month being requested.</p>
2220
2525
  */
2221
2526
  estimatedMinutesRemaining?: number;
@@ -2226,6 +2531,7 @@ export interface GetMinuteUsageResponse {
2226
2531
  */
2227
2532
  export interface GetMissionProfileRequest {
2228
2533
  /**
2534
+ * @public
2229
2535
  * <p>UUID of a mission profile.</p>
2230
2536
  */
2231
2537
  missionProfileId: string | undefined;
@@ -2236,52 +2542,64 @@ export interface GetMissionProfileRequest {
2236
2542
  */
2237
2543
  export interface GetMissionProfileResponse {
2238
2544
  /**
2545
+ * @public
2239
2546
  * <p>UUID of a mission profile.</p>
2240
2547
  */
2241
2548
  missionProfileId?: string;
2242
2549
  /**
2550
+ * @public
2243
2551
  * <p>ARN of a mission profile.</p>
2244
2552
  */
2245
2553
  missionProfileArn?: string;
2246
2554
  /**
2555
+ * @public
2247
2556
  * <p>Name of a mission profile.</p>
2248
2557
  */
2249
2558
  name?: string;
2250
2559
  /**
2560
+ * @public
2251
2561
  * <p>Region of a mission profile.</p>
2252
2562
  */
2253
2563
  region?: string;
2254
2564
  /**
2565
+ * @public
2255
2566
  * <p>Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.</p>
2256
2567
  */
2257
2568
  contactPrePassDurationSeconds?: number;
2258
2569
  /**
2570
+ * @public
2259
2571
  * <p>Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.</p>
2260
2572
  */
2261
2573
  contactPostPassDurationSeconds?: number;
2262
2574
  /**
2575
+ * @public
2263
2576
  * <p>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.</p>
2264
2577
  */
2265
2578
  minimumViableContactDurationSeconds?: number;
2266
2579
  /**
2580
+ * @public
2267
2581
  * <p>A list of lists of ARNs. Each list of ARNs is an edge, with a <i>from</i>
2268
2582
  * <code>Config</code> and a <i>to</i>
2269
2583
  * <code>Config</code>.</p>
2270
2584
  */
2271
2585
  dataflowEdges?: string[][];
2272
2586
  /**
2587
+ * @public
2273
2588
  * <p>ARN of a tracking <code>Config</code>.</p>
2274
2589
  */
2275
2590
  trackingConfigArn?: string;
2276
2591
  /**
2592
+ * @public
2277
2593
  * <p>Tags assigned to a mission profile.</p>
2278
2594
  */
2279
2595
  tags?: Record<string, string>;
2280
2596
  /**
2597
+ * @public
2281
2598
  * <p>KMS key to use for encrypting streams.</p>
2282
2599
  */
2283
2600
  streamsKmsKey?: KmsKey;
2284
2601
  /**
2602
+ * @public
2285
2603
  * <p>Role to use for encrypting streams with KMS key.</p>
2286
2604
  */
2287
2605
  streamsKmsRole?: string;
@@ -2292,6 +2610,7 @@ export interface GetMissionProfileResponse {
2292
2610
  */
2293
2611
  export interface GetSatelliteRequest {
2294
2612
  /**
2613
+ * @public
2295
2614
  * <p>UUID of a satellite.</p>
2296
2615
  */
2297
2616
  satelliteId: string | undefined;
@@ -2302,22 +2621,27 @@ export interface GetSatelliteRequest {
2302
2621
  */
2303
2622
  export interface GetSatelliteResponse {
2304
2623
  /**
2624
+ * @public
2305
2625
  * <p>UUID of a satellite.</p>
2306
2626
  */
2307
2627
  satelliteId?: string;
2308
2628
  /**
2629
+ * @public
2309
2630
  * <p>ARN of a satellite.</p>
2310
2631
  */
2311
2632
  satelliteArn?: string;
2312
2633
  /**
2634
+ * @public
2313
2635
  * <p>NORAD satellite ID number.</p>
2314
2636
  */
2315
2637
  noradSatelliteID?: number;
2316
2638
  /**
2639
+ * @public
2317
2640
  * <p>A list of ground stations to which the satellite is on-boarded.</p>
2318
2641
  */
2319
2642
  groundStations?: string[];
2320
2643
  /**
2644
+ * @public
2321
2645
  * <p>The current ephemeris being used to compute the trajectory of the satellite.</p>
2322
2646
  */
2323
2647
  currentEphemeris?: EphemerisMetaData;
@@ -2328,14 +2652,17 @@ export interface GetSatelliteResponse {
2328
2652
  */
2329
2653
  export interface ListGroundStationsRequest {
2330
2654
  /**
2655
+ * @public
2331
2656
  * <p>Satellite ID to retrieve on-boarded ground stations.</p>
2332
2657
  */
2333
2658
  satelliteId?: string;
2334
2659
  /**
2660
+ * @public
2335
2661
  * <p>Maximum number of ground stations returned.</p>
2336
2662
  */
2337
2663
  maxResults?: number;
2338
2664
  /**
2665
+ * @public
2339
2666
  * <p>Next token that can be supplied in the next call to get the next page of ground stations.</p>
2340
2667
  */
2341
2668
  nextToken?: string;
@@ -2346,14 +2673,17 @@ export interface ListGroundStationsRequest {
2346
2673
  */
2347
2674
  export interface GroundStationData {
2348
2675
  /**
2676
+ * @public
2349
2677
  * <p>UUID of a ground station.</p>
2350
2678
  */
2351
2679
  groundStationId?: string;
2352
2680
  /**
2681
+ * @public
2353
2682
  * <p>Name of a ground station.</p>
2354
2683
  */
2355
2684
  groundStationName?: string;
2356
2685
  /**
2686
+ * @public
2357
2687
  * <p>Ground station Region.</p>
2358
2688
  */
2359
2689
  region?: string;
@@ -2364,10 +2694,12 @@ export interface GroundStationData {
2364
2694
  */
2365
2695
  export interface ListGroundStationsResponse {
2366
2696
  /**
2697
+ * @public
2367
2698
  * <p>Next token that can be supplied in the next call to get the next page of ground stations.</p>
2368
2699
  */
2369
2700
  nextToken?: string;
2370
2701
  /**
2702
+ * @public
2371
2703
  * <p>List of ground stations.</p>
2372
2704
  */
2373
2705
  groundStationList?: GroundStationData[];
@@ -2378,6 +2710,7 @@ export interface ListGroundStationsResponse {
2378
2710
  */
2379
2711
  export interface ListTagsForResourceRequest {
2380
2712
  /**
2713
+ * @public
2381
2714
  * <p>ARN of a resource.</p>
2382
2715
  */
2383
2716
  resourceArn: string | undefined;
@@ -2388,6 +2721,7 @@ export interface ListTagsForResourceRequest {
2388
2721
  */
2389
2722
  export interface ListTagsForResourceResponse {
2390
2723
  /**
2724
+ * @public
2391
2725
  * <p>Tags assigned to a resource.</p>
2392
2726
  */
2393
2727
  tags?: Record<string, string>;
@@ -2398,10 +2732,12 @@ export interface ListTagsForResourceResponse {
2398
2732
  */
2399
2733
  export interface ListMissionProfilesRequest {
2400
2734
  /**
2735
+ * @public
2401
2736
  * <p>Maximum number of mission profiles returned.</p>
2402
2737
  */
2403
2738
  maxResults?: number;
2404
2739
  /**
2740
+ * @public
2405
2741
  * <p>Next token returned in the request of a previous <code>ListMissionProfiles</code> call. Used to get the next page of results.</p>
2406
2742
  */
2407
2743
  nextToken?: string;
@@ -2412,18 +2748,22 @@ export interface ListMissionProfilesRequest {
2412
2748
  */
2413
2749
  export interface MissionProfileListItem {
2414
2750
  /**
2751
+ * @public
2415
2752
  * <p>UUID of a mission profile.</p>
2416
2753
  */
2417
2754
  missionProfileId?: string;
2418
2755
  /**
2756
+ * @public
2419
2757
  * <p>ARN of a mission profile.</p>
2420
2758
  */
2421
2759
  missionProfileArn?: string;
2422
2760
  /**
2761
+ * @public
2423
2762
  * <p>Region of a mission profile.</p>
2424
2763
  */
2425
2764
  region?: string;
2426
2765
  /**
2766
+ * @public
2427
2767
  * <p>Name of a mission profile.</p>
2428
2768
  */
2429
2769
  name?: string;
@@ -2434,10 +2774,12 @@ export interface MissionProfileListItem {
2434
2774
  */
2435
2775
  export interface ListMissionProfilesResponse {
2436
2776
  /**
2777
+ * @public
2437
2778
  * <p>Next token returned in the response of a previous <code>ListMissionProfiles</code> call. Used to get the next page of results.</p>
2438
2779
  */
2439
2780
  nextToken?: string;
2440
2781
  /**
2782
+ * @public
2441
2783
  * <p>List of mission profiles.</p>
2442
2784
  */
2443
2785
  missionProfileList?: MissionProfileListItem[];
@@ -2448,40 +2790,49 @@ export interface ListMissionProfilesResponse {
2448
2790
  */
2449
2791
  export interface UpdateMissionProfileRequest {
2450
2792
  /**
2793
+ * @public
2451
2794
  * <p>UUID of a mission profile.</p>
2452
2795
  */
2453
2796
  missionProfileId: string | undefined;
2454
2797
  /**
2798
+ * @public
2455
2799
  * <p>Name of a mission profile.</p>
2456
2800
  */
2457
2801
  name?: string;
2458
2802
  /**
2803
+ * @public
2459
2804
  * <p>Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.</p>
2460
2805
  */
2461
2806
  contactPrePassDurationSeconds?: number;
2462
2807
  /**
2808
+ * @public
2463
2809
  * <p>Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.</p>
2464
2810
  */
2465
2811
  contactPostPassDurationSeconds?: number;
2466
2812
  /**
2813
+ * @public
2467
2814
  * <p>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.</p>
2468
2815
  */
2469
2816
  minimumViableContactDurationSeconds?: number;
2470
2817
  /**
2818
+ * @public
2471
2819
  * <p>A list of lists of ARNs. Each list of ARNs is an edge, with a <i>from</i>
2472
2820
  * <code>Config</code> and a <i>to</i>
2473
2821
  * <code>Config</code>.</p>
2474
2822
  */
2475
2823
  dataflowEdges?: string[][];
2476
2824
  /**
2825
+ * @public
2477
2826
  * <p>ARN of a tracking <code>Config</code>.</p>
2478
2827
  */
2479
2828
  trackingConfigArn?: string;
2480
2829
  /**
2830
+ * @public
2481
2831
  * <p>KMS key to use for encrypting streams.</p>
2482
2832
  */
2483
2833
  streamsKmsKey?: KmsKey;
2484
2834
  /**
2835
+ * @public
2485
2836
  * <p>Role to use for encrypting streams with KMS key.</p>
2486
2837
  */
2487
2838
  streamsKmsRole?: string;
@@ -2492,10 +2843,12 @@ export interface UpdateMissionProfileRequest {
2492
2843
  */
2493
2844
  export interface ListSatellitesRequest {
2494
2845
  /**
2846
+ * @public
2495
2847
  * <p>Maximum number of satellites returned.</p>
2496
2848
  */
2497
2849
  maxResults?: number;
2498
2850
  /**
2851
+ * @public
2499
2852
  * <p>Next token that can be supplied in the next call to get the next page of satellites.</p>
2500
2853
  */
2501
2854
  nextToken?: string;
@@ -2506,22 +2859,27 @@ export interface ListSatellitesRequest {
2506
2859
  */
2507
2860
  export interface SatelliteListItem {
2508
2861
  /**
2862
+ * @public
2509
2863
  * <p>UUID of a satellite.</p>
2510
2864
  */
2511
2865
  satelliteId?: string;
2512
2866
  /**
2867
+ * @public
2513
2868
  * <p>ARN of a satellite.</p>
2514
2869
  */
2515
2870
  satelliteArn?: string;
2516
2871
  /**
2872
+ * @public
2517
2873
  * <p>NORAD satellite ID number.</p>
2518
2874
  */
2519
2875
  noradSatelliteID?: number;
2520
2876
  /**
2877
+ * @public
2521
2878
  * <p>A list of ground stations to which the satellite is on-boarded.</p>
2522
2879
  */
2523
2880
  groundStations?: string[];
2524
2881
  /**
2882
+ * @public
2525
2883
  * <p>The current ephemeris being used to compute the trajectory of the satellite.</p>
2526
2884
  */
2527
2885
  currentEphemeris?: EphemerisMetaData;
@@ -2532,10 +2890,12 @@ export interface SatelliteListItem {
2532
2890
  */
2533
2891
  export interface ListSatellitesResponse {
2534
2892
  /**
2893
+ * @public
2535
2894
  * <p>Next token that can be supplied in the next call to get the next page of satellites.</p>
2536
2895
  */
2537
2896
  nextToken?: string;
2538
2897
  /**
2898
+ * @public
2539
2899
  * <p>List of satellites.</p>
2540
2900
  */
2541
2901
  satellites?: SatelliteListItem[];
@@ -2546,10 +2906,12 @@ export interface ListSatellitesResponse {
2546
2906
  */
2547
2907
  export interface TagResourceRequest {
2548
2908
  /**
2909
+ * @public
2549
2910
  * <p>ARN of a resource tag.</p>
2550
2911
  */
2551
2912
  resourceArn: string | undefined;
2552
2913
  /**
2914
+ * @public
2553
2915
  * <p>Tags assigned to a resource.</p>
2554
2916
  */
2555
2917
  tags: Record<string, string> | undefined;
@@ -2566,10 +2928,12 @@ export interface TagResourceResponse {
2566
2928
  */
2567
2929
  export interface UntagResourceRequest {
2568
2930
  /**
2931
+ * @public
2569
2932
  * <p>ARN of a resource.</p>
2570
2933
  */
2571
2934
  resourceArn: string | undefined;
2572
2935
  /**
2936
+ * @public
2573
2937
  * <p>Keys of a resource tag.</p>
2574
2938
  */
2575
2939
  tagKeys: string[] | undefined;