UNPKG

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