@aws-sdk/client-groundstation 3.295.0 → 3.297.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.
Files changed (46) hide show
  1. package/dist-types/GroundStation.d.ts +34 -0
  2. package/dist-types/GroundStationClient.d.ts +24 -4
  3. package/dist-types/commands/CancelContactCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateConfigCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateDataflowEndpointGroupCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateEphemerisCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateMissionProfileCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteConfigCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteDataflowEndpointGroupCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteEphemerisCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteMissionProfileCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeContactCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeEphemerisCommand.d.ts +16 -0
  14. package/dist-types/commands/GetAgentConfigurationCommand.d.ts +16 -0
  15. package/dist-types/commands/GetConfigCommand.d.ts +16 -0
  16. package/dist-types/commands/GetDataflowEndpointGroupCommand.d.ts +16 -0
  17. package/dist-types/commands/GetMinuteUsageCommand.d.ts +16 -0
  18. package/dist-types/commands/GetMissionProfileCommand.d.ts +16 -0
  19. package/dist-types/commands/GetSatelliteCommand.d.ts +16 -0
  20. package/dist-types/commands/ListConfigsCommand.d.ts +16 -0
  21. package/dist-types/commands/ListContactsCommand.d.ts +16 -0
  22. package/dist-types/commands/ListDataflowEndpointGroupsCommand.d.ts +16 -0
  23. package/dist-types/commands/ListEphemeridesCommand.d.ts +16 -0
  24. package/dist-types/commands/ListGroundStationsCommand.d.ts +16 -0
  25. package/dist-types/commands/ListMissionProfilesCommand.d.ts +16 -0
  26. package/dist-types/commands/ListSatellitesCommand.d.ts +16 -0
  27. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  28. package/dist-types/commands/RegisterAgentCommand.d.ts +16 -0
  29. package/dist-types/commands/ReserveContactCommand.d.ts +16 -0
  30. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  31. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  32. package/dist-types/commands/UpdateAgentStatusCommand.d.ts +16 -0
  33. package/dist-types/commands/UpdateConfigCommand.d.ts +16 -0
  34. package/dist-types/commands/UpdateEphemerisCommand.d.ts +16 -0
  35. package/dist-types/commands/UpdateMissionProfileCommand.d.ts +16 -0
  36. package/dist-types/models/GroundStationServiceException.d.ts +2 -0
  37. package/dist-types/models/models_0.d.ts +203 -0
  38. package/dist-types/pagination/Interfaces.d.ts +3 -0
  39. package/dist-types/pagination/ListConfigsPaginator.d.ts +3 -0
  40. package/dist-types/pagination/ListContactsPaginator.d.ts +3 -0
  41. package/dist-types/pagination/ListDataflowEndpointGroupsPaginator.d.ts +3 -0
  42. package/dist-types/pagination/ListEphemeridesPaginator.d.ts +3 -0
  43. package/dist-types/pagination/ListGroundStationsPaginator.d.ts +3 -0
  44. package/dist-types/pagination/ListMissionProfilesPaginator.d.ts +3 -0
  45. package/dist-types/pagination/ListSatellitesPaginator.d.ts +3 -0
  46. package/package.json +30 -30
@@ -34,6 +34,7 @@ import { UpdateEphemerisCommandInput, UpdateEphemerisCommandOutput } from "./com
34
34
  import { UpdateMissionProfileCommandInput, UpdateMissionProfileCommandOutput } from "./commands/UpdateMissionProfileCommand";
35
35
  import { GroundStationClient } from "./GroundStationClient";
36
36
  /**
37
+ * @public
37
38
  * <p>Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that
38
39
  * enables you to control satellite communications, downlink and process satellite data, and
39
40
  * scale your satellite operations efficiently and cost-effectively without having
@@ -41,12 +42,14 @@ import { GroundStationClient } from "./GroundStationClient";
41
42
  */
42
43
  export declare class GroundStation extends GroundStationClient {
43
44
  /**
45
+ * @public
44
46
  * <p>Cancels a contact with a specified contact ID.</p>
45
47
  */
46
48
  cancelContact(args: CancelContactCommandInput, options?: __HttpHandlerOptions): Promise<CancelContactCommandOutput>;
47
49
  cancelContact(args: CancelContactCommandInput, cb: (err: any, data?: CancelContactCommandOutput) => void): void;
48
50
  cancelContact(args: CancelContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelContactCommandOutput) => void): void;
49
51
  /**
52
+ * @public
50
53
  * <p>Creates a <code>Config</code> with the specified <code>configData</code> parameters.</p>
51
54
  * <p>Only one type of <code>configData</code> can be specified.</p>
52
55
  */
@@ -54,6 +57,7 @@ export declare class GroundStation extends GroundStationClient {
54
57
  createConfig(args: CreateConfigCommandInput, cb: (err: any, data?: CreateConfigCommandOutput) => void): void;
55
58
  createConfig(args: CreateConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigCommandOutput) => void): void;
56
59
  /**
60
+ * @public
57
61
  * <p>Creates a <code>DataflowEndpoint</code> group containing the specified list of <code>DataflowEndpoint</code> objects.</p>
58
62
  * <p>The <code>name</code> field in each endpoint is used in your mission profile <code>DataflowEndpointConfig</code>
59
63
  * to specify which endpoints to use during a contact.</p>
@@ -64,12 +68,14 @@ export declare class GroundStation extends GroundStationClient {
64
68
  createDataflowEndpointGroup(args: CreateDataflowEndpointGroupCommandInput, cb: (err: any, data?: CreateDataflowEndpointGroupCommandOutput) => void): void;
65
69
  createDataflowEndpointGroup(args: CreateDataflowEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataflowEndpointGroupCommandOutput) => void): void;
66
70
  /**
71
+ * @public
67
72
  * <p>Creates an Ephemeris with the specified <code>EphemerisData</code>.</p>
68
73
  */
69
74
  createEphemeris(args: CreateEphemerisCommandInput, options?: __HttpHandlerOptions): Promise<CreateEphemerisCommandOutput>;
70
75
  createEphemeris(args: CreateEphemerisCommandInput, cb: (err: any, data?: CreateEphemerisCommandOutput) => void): void;
71
76
  createEphemeris(args: CreateEphemerisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEphemerisCommandOutput) => void): void;
72
77
  /**
78
+ * @public
73
79
  * <p>Creates a mission profile.</p>
74
80
  * <p>
75
81
  * <code>dataflowEdges</code> is a list of lists of strings. Each lower level list of strings
@@ -79,48 +85,56 @@ export declare class GroundStation extends GroundStationClient {
79
85
  createMissionProfile(args: CreateMissionProfileCommandInput, cb: (err: any, data?: CreateMissionProfileCommandOutput) => void): void;
80
86
  createMissionProfile(args: CreateMissionProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMissionProfileCommandOutput) => void): void;
81
87
  /**
88
+ * @public
82
89
  * <p>Deletes a <code>Config</code>.</p>
83
90
  */
84
91
  deleteConfig(args: DeleteConfigCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConfigCommandOutput>;
85
92
  deleteConfig(args: DeleteConfigCommandInput, cb: (err: any, data?: DeleteConfigCommandOutput) => void): void;
86
93
  deleteConfig(args: DeleteConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigCommandOutput) => void): void;
87
94
  /**
95
+ * @public
88
96
  * <p>Deletes a dataflow endpoint group.</p>
89
97
  */
90
98
  deleteDataflowEndpointGroup(args: DeleteDataflowEndpointGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDataflowEndpointGroupCommandOutput>;
91
99
  deleteDataflowEndpointGroup(args: DeleteDataflowEndpointGroupCommandInput, cb: (err: any, data?: DeleteDataflowEndpointGroupCommandOutput) => void): void;
92
100
  deleteDataflowEndpointGroup(args: DeleteDataflowEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataflowEndpointGroupCommandOutput) => void): void;
93
101
  /**
102
+ * @public
94
103
  * <p>Deletes an ephemeris</p>
95
104
  */
96
105
  deleteEphemeris(args: DeleteEphemerisCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEphemerisCommandOutput>;
97
106
  deleteEphemeris(args: DeleteEphemerisCommandInput, cb: (err: any, data?: DeleteEphemerisCommandOutput) => void): void;
98
107
  deleteEphemeris(args: DeleteEphemerisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEphemerisCommandOutput) => void): void;
99
108
  /**
109
+ * @public
100
110
  * <p>Deletes a mission profile.</p>
101
111
  */
102
112
  deleteMissionProfile(args: DeleteMissionProfileCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMissionProfileCommandOutput>;
103
113
  deleteMissionProfile(args: DeleteMissionProfileCommandInput, cb: (err: any, data?: DeleteMissionProfileCommandOutput) => void): void;
104
114
  deleteMissionProfile(args: DeleteMissionProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMissionProfileCommandOutput) => void): void;
105
115
  /**
116
+ * @public
106
117
  * <p>Describes an existing contact.</p>
107
118
  */
108
119
  describeContact(args: DescribeContactCommandInput, options?: __HttpHandlerOptions): Promise<DescribeContactCommandOutput>;
109
120
  describeContact(args: DescribeContactCommandInput, cb: (err: any, data?: DescribeContactCommandOutput) => void): void;
110
121
  describeContact(args: DescribeContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContactCommandOutput) => void): void;
111
122
  /**
123
+ * @public
112
124
  * <p>Describes an existing ephemeris.</p>
113
125
  */
114
126
  describeEphemeris(args: DescribeEphemerisCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEphemerisCommandOutput>;
115
127
  describeEphemeris(args: DescribeEphemerisCommandInput, cb: (err: any, data?: DescribeEphemerisCommandOutput) => void): void;
116
128
  describeEphemeris(args: DescribeEphemerisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEphemerisCommandOutput) => void): void;
117
129
  /**
130
+ * @public
118
131
  * <p>Gets the latest configuration information for a registered agent.</p>
119
132
  */
120
133
  getAgentConfiguration(args: GetAgentConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetAgentConfigurationCommandOutput>;
121
134
  getAgentConfiguration(args: GetAgentConfigurationCommandInput, cb: (err: any, data?: GetAgentConfigurationCommandOutput) => void): void;
122
135
  getAgentConfiguration(args: GetAgentConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAgentConfigurationCommandOutput) => void): void;
123
136
  /**
137
+ * @public
124
138
  * <p>Returns <code>Config</code> information.</p>
125
139
  * <p>Only one <code>Config</code> response can be returned.</p>
126
140
  */
@@ -128,36 +142,42 @@ export declare class GroundStation extends GroundStationClient {
128
142
  getConfig(args: GetConfigCommandInput, cb: (err: any, data?: GetConfigCommandOutput) => void): void;
129
143
  getConfig(args: GetConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigCommandOutput) => void): void;
130
144
  /**
145
+ * @public
131
146
  * <p>Returns the dataflow endpoint group.</p>
132
147
  */
133
148
  getDataflowEndpointGroup(args: GetDataflowEndpointGroupCommandInput, options?: __HttpHandlerOptions): Promise<GetDataflowEndpointGroupCommandOutput>;
134
149
  getDataflowEndpointGroup(args: GetDataflowEndpointGroupCommandInput, cb: (err: any, data?: GetDataflowEndpointGroupCommandOutput) => void): void;
135
150
  getDataflowEndpointGroup(args: GetDataflowEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataflowEndpointGroupCommandOutput) => void): void;
136
151
  /**
152
+ * @public
137
153
  * <p>Returns the number of minutes used by account.</p>
138
154
  */
139
155
  getMinuteUsage(args: GetMinuteUsageCommandInput, options?: __HttpHandlerOptions): Promise<GetMinuteUsageCommandOutput>;
140
156
  getMinuteUsage(args: GetMinuteUsageCommandInput, cb: (err: any, data?: GetMinuteUsageCommandOutput) => void): void;
141
157
  getMinuteUsage(args: GetMinuteUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMinuteUsageCommandOutput) => void): void;
142
158
  /**
159
+ * @public
143
160
  * <p>Returns a mission profile.</p>
144
161
  */
145
162
  getMissionProfile(args: GetMissionProfileCommandInput, options?: __HttpHandlerOptions): Promise<GetMissionProfileCommandOutput>;
146
163
  getMissionProfile(args: GetMissionProfileCommandInput, cb: (err: any, data?: GetMissionProfileCommandOutput) => void): void;
147
164
  getMissionProfile(args: GetMissionProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMissionProfileCommandOutput) => void): void;
148
165
  /**
166
+ * @public
149
167
  * <p>Returns a satellite.</p>
150
168
  */
151
169
  getSatellite(args: GetSatelliteCommandInput, options?: __HttpHandlerOptions): Promise<GetSatelliteCommandOutput>;
152
170
  getSatellite(args: GetSatelliteCommandInput, cb: (err: any, data?: GetSatelliteCommandOutput) => void): void;
153
171
  getSatellite(args: GetSatelliteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSatelliteCommandOutput) => void): void;
154
172
  /**
173
+ * @public
155
174
  * <p>Returns a list of <code>Config</code> objects.</p>
156
175
  */
157
176
  listConfigs(args: ListConfigsCommandInput, options?: __HttpHandlerOptions): Promise<ListConfigsCommandOutput>;
158
177
  listConfigs(args: ListConfigsCommandInput, cb: (err: any, data?: ListConfigsCommandOutput) => void): void;
159
178
  listConfigs(args: ListConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigsCommandOutput) => void): void;
160
179
  /**
180
+ * @public
161
181
  * <p>Returns a list of contacts.</p>
162
182
  * <p>If <code>statusList</code> contains AVAILABLE, the request must include
163
183
  * <code>groundStation</code>, <code>missionprofileArn</code>, and <code>satelliteArn</code>.
@@ -167,72 +187,84 @@ export declare class GroundStation extends GroundStationClient {
167
187
  listContacts(args: ListContactsCommandInput, cb: (err: any, data?: ListContactsCommandOutput) => void): void;
168
188
  listContacts(args: ListContactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContactsCommandOutput) => void): void;
169
189
  /**
190
+ * @public
170
191
  * <p>Returns a list of <code>DataflowEndpoint</code> groups.</p>
171
192
  */
172
193
  listDataflowEndpointGroups(args: ListDataflowEndpointGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListDataflowEndpointGroupsCommandOutput>;
173
194
  listDataflowEndpointGroups(args: ListDataflowEndpointGroupsCommandInput, cb: (err: any, data?: ListDataflowEndpointGroupsCommandOutput) => void): void;
174
195
  listDataflowEndpointGroups(args: ListDataflowEndpointGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataflowEndpointGroupsCommandOutput) => void): void;
175
196
  /**
197
+ * @public
176
198
  * <p>List existing ephemerides.</p>
177
199
  */
178
200
  listEphemerides(args: ListEphemeridesCommandInput, options?: __HttpHandlerOptions): Promise<ListEphemeridesCommandOutput>;
179
201
  listEphemerides(args: ListEphemeridesCommandInput, cb: (err: any, data?: ListEphemeridesCommandOutput) => void): void;
180
202
  listEphemerides(args: ListEphemeridesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEphemeridesCommandOutput) => void): void;
181
203
  /**
204
+ * @public
182
205
  * <p>Returns a list of ground stations. </p>
183
206
  */
184
207
  listGroundStations(args: ListGroundStationsCommandInput, options?: __HttpHandlerOptions): Promise<ListGroundStationsCommandOutput>;
185
208
  listGroundStations(args: ListGroundStationsCommandInput, cb: (err: any, data?: ListGroundStationsCommandOutput) => void): void;
186
209
  listGroundStations(args: ListGroundStationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroundStationsCommandOutput) => void): void;
187
210
  /**
211
+ * @public
188
212
  * <p>Returns a list of mission profiles.</p>
189
213
  */
190
214
  listMissionProfiles(args: ListMissionProfilesCommandInput, options?: __HttpHandlerOptions): Promise<ListMissionProfilesCommandOutput>;
191
215
  listMissionProfiles(args: ListMissionProfilesCommandInput, cb: (err: any, data?: ListMissionProfilesCommandOutput) => void): void;
192
216
  listMissionProfiles(args: ListMissionProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMissionProfilesCommandOutput) => void): void;
193
217
  /**
218
+ * @public
194
219
  * <p>Returns a list of satellites.</p>
195
220
  */
196
221
  listSatellites(args: ListSatellitesCommandInput, options?: __HttpHandlerOptions): Promise<ListSatellitesCommandOutput>;
197
222
  listSatellites(args: ListSatellitesCommandInput, cb: (err: any, data?: ListSatellitesCommandOutput) => void): void;
198
223
  listSatellites(args: ListSatellitesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSatellitesCommandOutput) => void): void;
199
224
  /**
225
+ * @public
200
226
  * <p>Returns a list of tags for a specified resource.</p>
201
227
  */
202
228
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
203
229
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
204
230
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
205
231
  /**
232
+ * @public
206
233
  * <p>Registers a new agent with AWS Groundstation.</p>
207
234
  */
208
235
  registerAgent(args: RegisterAgentCommandInput, options?: __HttpHandlerOptions): Promise<RegisterAgentCommandOutput>;
209
236
  registerAgent(args: RegisterAgentCommandInput, cb: (err: any, data?: RegisterAgentCommandOutput) => void): void;
210
237
  registerAgent(args: RegisterAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterAgentCommandOutput) => void): void;
211
238
  /**
239
+ * @public
212
240
  * <p>Reserves a contact using specified parameters.</p>
213
241
  */
214
242
  reserveContact(args: ReserveContactCommandInput, options?: __HttpHandlerOptions): Promise<ReserveContactCommandOutput>;
215
243
  reserveContact(args: ReserveContactCommandInput, cb: (err: any, data?: ReserveContactCommandOutput) => void): void;
216
244
  reserveContact(args: ReserveContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReserveContactCommandOutput) => void): void;
217
245
  /**
246
+ * @public
218
247
  * <p>Assigns a tag to a resource.</p>
219
248
  */
220
249
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
221
250
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
222
251
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
223
252
  /**
253
+ * @public
224
254
  * <p>Deassigns a resource tag.</p>
225
255
  */
226
256
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
227
257
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
228
258
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
229
259
  /**
260
+ * @public
230
261
  * <p>Update the status of the agent.</p>
231
262
  */
232
263
  updateAgentStatus(args: UpdateAgentStatusCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAgentStatusCommandOutput>;
233
264
  updateAgentStatus(args: UpdateAgentStatusCommandInput, cb: (err: any, data?: UpdateAgentStatusCommandOutput) => void): void;
234
265
  updateAgentStatus(args: UpdateAgentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAgentStatusCommandOutput) => void): void;
235
266
  /**
267
+ * @public
236
268
  * <p>Updates the <code>Config</code> used when scheduling contacts.</p>
237
269
  * <p>Updating a <code>Config</code> will not update the execution parameters
238
270
  * for existing future contacts scheduled with this <code>Config</code>.</p>
@@ -241,12 +273,14 @@ export declare class GroundStation extends GroundStationClient {
241
273
  updateConfig(args: UpdateConfigCommandInput, cb: (err: any, data?: UpdateConfigCommandOutput) => void): void;
242
274
  updateConfig(args: UpdateConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigCommandOutput) => void): void;
243
275
  /**
276
+ * @public
244
277
  * <p>Updates an existing ephemeris</p>
245
278
  */
246
279
  updateEphemeris(args: UpdateEphemerisCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEphemerisCommandOutput>;
247
280
  updateEphemeris(args: UpdateEphemerisCommandInput, cb: (err: any, data?: UpdateEphemerisCommandOutput) => void): void;
248
281
  updateEphemeris(args: UpdateEphemerisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEphemerisCommandOutput) => void): void;
249
282
  /**
283
+ * @public
250
284
  * <p>Updates a mission profile.</p>
251
285
  * <p>Updating a mission profile will not update the execution parameters
252
286
  * for existing future contacts.</p>
@@ -41,15 +41,24 @@ import { UpdateConfigCommandInput, UpdateConfigCommandOutput } from "./commands/
41
41
  import { UpdateEphemerisCommandInput, UpdateEphemerisCommandOutput } from "./commands/UpdateEphemerisCommand";
42
42
  import { UpdateMissionProfileCommandInput, UpdateMissionProfileCommandOutput } from "./commands/UpdateMissionProfileCommand";
43
43
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
44
+ /**
45
+ * @public
46
+ */
44
47
  export type ServiceInputTypes = CancelContactCommandInput | CreateConfigCommandInput | CreateDataflowEndpointGroupCommandInput | CreateEphemerisCommandInput | CreateMissionProfileCommandInput | DeleteConfigCommandInput | DeleteDataflowEndpointGroupCommandInput | DeleteEphemerisCommandInput | DeleteMissionProfileCommandInput | DescribeContactCommandInput | DescribeEphemerisCommandInput | GetAgentConfigurationCommandInput | GetConfigCommandInput | GetDataflowEndpointGroupCommandInput | GetMinuteUsageCommandInput | GetMissionProfileCommandInput | GetSatelliteCommandInput | ListConfigsCommandInput | ListContactsCommandInput | ListDataflowEndpointGroupsCommandInput | ListEphemeridesCommandInput | ListGroundStationsCommandInput | ListMissionProfilesCommandInput | ListSatellitesCommandInput | ListTagsForResourceCommandInput | RegisterAgentCommandInput | ReserveContactCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAgentStatusCommandInput | UpdateConfigCommandInput | UpdateEphemerisCommandInput | UpdateMissionProfileCommandInput;
48
+ /**
49
+ * @public
50
+ */
45
51
  export type ServiceOutputTypes = CancelContactCommandOutput | CreateConfigCommandOutput | CreateDataflowEndpointGroupCommandOutput | CreateEphemerisCommandOutput | CreateMissionProfileCommandOutput | DeleteConfigCommandOutput | DeleteDataflowEndpointGroupCommandOutput | DeleteEphemerisCommandOutput | DeleteMissionProfileCommandOutput | DescribeContactCommandOutput | DescribeEphemerisCommandOutput | GetAgentConfigurationCommandOutput | GetConfigCommandOutput | GetDataflowEndpointGroupCommandOutput | GetMinuteUsageCommandOutput | GetMissionProfileCommandOutput | GetSatelliteCommandOutput | ListConfigsCommandOutput | ListContactsCommandOutput | ListDataflowEndpointGroupsCommandOutput | ListEphemeridesCommandOutput | ListGroundStationsCommandOutput | ListMissionProfilesCommandOutput | ListSatellitesCommandOutput | ListTagsForResourceCommandOutput | RegisterAgentCommandOutput | ReserveContactCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAgentStatusCommandOutput | UpdateConfigCommandOutput | UpdateEphemerisCommandOutput | UpdateMissionProfileCommandOutput;
52
+ /**
53
+ * @public
54
+ */
46
55
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
47
56
  /**
48
57
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
49
58
  */
50
59
  requestHandler?: __HttpHandler;
51
60
  /**
52
- * A constructor for a class implementing the {@link __Checksum} interface
61
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
53
62
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
54
63
  * @internal
55
64
  */
@@ -139,23 +148,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
139
148
  */
140
149
  logger?: __Logger;
141
150
  /**
142
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
151
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
143
152
  */
144
153
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
145
154
  }
155
+ /**
156
+ * @public
157
+ */
146
158
  type GroundStationClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
147
159
  /**
148
- * The configuration interface of GroundStationClient class constructor that set the region, credentials and other options.
160
+ * @public
161
+ *
162
+ * The configuration interface of GroundStationClient class constructor that set the region, credentials and other options.
149
163
  */
150
164
  export interface GroundStationClientConfig extends GroundStationClientConfigType {
151
165
  }
166
+ /**
167
+ * @public
168
+ */
152
169
  type GroundStationClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
153
170
  /**
154
- * The resolved configuration interface of GroundStationClient class. This is resolved and normalized from the {@link GroundStationClientConfig | constructor configuration interface}.
171
+ * @public
172
+ *
173
+ * The resolved configuration interface of GroundStationClient class. This is resolved and normalized from the {@link GroundStationClientConfig | constructor configuration interface}.
155
174
  */
156
175
  export interface GroundStationClientResolvedConfig extends GroundStationClientResolvedConfigType {
157
176
  }
158
177
  /**
178
+ * @public
159
179
  * <p>Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that
160
180
  * enables you to control satellite communications, downlink and process satellite data, and
161
181
  * scale your satellite operations efficiently and cost-effectively without having
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GroundStationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GroundStationClient";
5
5
  import { CancelContactRequest, ContactIdResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CancelContactCommand}.
8
10
  */
9
11
  export interface CancelContactCommandInput extends CancelContactRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CancelContactCommand}.
13
17
  */
14
18
  export interface CancelContactCommandOutput extends ContactIdResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Cancels a contact with a specified contact ID.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CancelContactCommandOutput extends ContactIdResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CancelContactCommandInput - {@link CancelContactCommandInput}
34
+ * @returns {@link CancelContactCommandOutput}
28
35
  * @see {@link CancelContactCommandInput} for command's `input` shape.
29
36
  * @see {@link CancelContactCommandOutput} for command's `response` shape.
30
37
  * @see {@link GroundStationClientResolvedConfig | config} for GroundStationClient's `config` shape.
@@ -43,11 +50,20 @@ export interface CancelContactCommandOutput extends ContactIdResponse, __Metadat
43
50
  export declare class CancelContactCommand extends $Command<CancelContactCommandInput, CancelContactCommandOutput, GroundStationClientResolvedConfig> {
44
51
  readonly input: CancelContactCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: CancelContactCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GroundStationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelContactCommandInput, CancelContactCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GroundStationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GroundStationClient";
5
5
  import { ConfigIdResponse, CreateConfigRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateConfigCommand}.
8
10
  */
9
11
  export interface CreateConfigCommandInput extends CreateConfigRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateConfigCommand}.
13
17
  */
14
18
  export interface CreateConfigCommandOutput extends ConfigIdResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a <code>Config</code> with the specified <code>configData</code> parameters.</p>
18
23
  * <p>Only one type of <code>configData</code> can be specified.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateConfigCommandOutput extends ConfigIdResponse, __MetadataB
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateConfigCommandInput - {@link CreateConfigCommandInput}
35
+ * @returns {@link CreateConfigCommandOutput}
29
36
  * @see {@link CreateConfigCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateConfigCommandOutput} for command's `response` shape.
31
38
  * @see {@link GroundStationClientResolvedConfig | config} for GroundStationClient's `config` shape.
@@ -47,11 +54,20 @@ export interface CreateConfigCommandOutput extends ConfigIdResponse, __MetadataB
47
54
  export declare class CreateConfigCommand extends $Command<CreateConfigCommandInput, CreateConfigCommandOutput, GroundStationClientResolvedConfig> {
48
55
  readonly input: CreateConfigCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: CreateConfigCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GroundStationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateConfigCommandInput, CreateConfigCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GroundStationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GroundStationClient";
5
5
  import { CreateDataflowEndpointGroupRequest, DataflowEndpointGroupIdResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDataflowEndpointGroupCommand}.
8
10
  */
9
11
  export interface CreateDataflowEndpointGroupCommandInput extends CreateDataflowEndpointGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDataflowEndpointGroupCommand}.
13
17
  */
14
18
  export interface CreateDataflowEndpointGroupCommandOutput extends DataflowEndpointGroupIdResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a <code>DataflowEndpoint</code> group containing the specified list of <code>DataflowEndpoint</code> objects.</p>
18
23
  * <p>The <code>name</code> field in each endpoint is used in your mission profile <code>DataflowEndpointConfig</code>
19
24
  * to specify which endpoints to use during a contact.</p>
@@ -29,6 +34,8 @@ export interface CreateDataflowEndpointGroupCommandOutput extends DataflowEndpoi
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateDataflowEndpointGroupCommandInput - {@link CreateDataflowEndpointGroupCommandInput}
38
+ * @returns {@link CreateDataflowEndpointGroupCommandOutput}
32
39
  * @see {@link CreateDataflowEndpointGroupCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateDataflowEndpointGroupCommandOutput} for command's `response` shape.
34
41
  * @see {@link GroundStationClientResolvedConfig | config} for GroundStationClient's `config` shape.
@@ -47,11 +54,20 @@ export interface CreateDataflowEndpointGroupCommandOutput extends DataflowEndpoi
47
54
  export declare class CreateDataflowEndpointGroupCommand extends $Command<CreateDataflowEndpointGroupCommandInput, CreateDataflowEndpointGroupCommandOutput, GroundStationClientResolvedConfig> {
48
55
  readonly input: CreateDataflowEndpointGroupCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: CreateDataflowEndpointGroupCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GroundStationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDataflowEndpointGroupCommandInput, CreateDataflowEndpointGroupCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GroundStationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GroundStationClient";
5
5
  import { CreateEphemerisRequest, EphemerisIdResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateEphemerisCommand}.
8
10
  */
9
11
  export interface CreateEphemerisCommandInput extends CreateEphemerisRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateEphemerisCommand}.
13
17
  */
14
18
  export interface CreateEphemerisCommandOutput extends EphemerisIdResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an Ephemeris with the specified <code>EphemerisData</code>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateEphemerisCommandOutput extends EphemerisIdResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateEphemerisCommandInput - {@link CreateEphemerisCommandInput}
34
+ * @returns {@link CreateEphemerisCommandOutput}
28
35
  * @see {@link CreateEphemerisCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateEphemerisCommandOutput} for command's `response` shape.
30
37
  * @see {@link GroundStationClientResolvedConfig | config} for GroundStationClient's `config` shape.
@@ -43,11 +50,20 @@ export interface CreateEphemerisCommandOutput extends EphemerisIdResponse, __Met
43
50
  export declare class CreateEphemerisCommand extends $Command<CreateEphemerisCommandInput, CreateEphemerisCommandOutput, GroundStationClientResolvedConfig> {
44
51
  readonly input: CreateEphemerisCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: CreateEphemerisCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GroundStationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateEphemerisCommandInput, CreateEphemerisCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GroundStationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GroundStationClient";
5
5
  import { CreateMissionProfileRequest, MissionProfileIdResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateMissionProfileCommand}.
8
10
  */
9
11
  export interface CreateMissionProfileCommandInput extends CreateMissionProfileRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateMissionProfileCommand}.
13
17
  */
14
18
  export interface CreateMissionProfileCommandOutput extends MissionProfileIdResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a mission profile.</p>
18
23
  * <p>
19
24
  * <code>dataflowEdges</code> is a list of lists of strings. Each lower level list of strings
@@ -28,6 +33,8 @@ export interface CreateMissionProfileCommandOutput extends MissionProfileIdRespo
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateMissionProfileCommandInput - {@link CreateMissionProfileCommandInput}
37
+ * @returns {@link CreateMissionProfileCommandOutput}
31
38
  * @see {@link CreateMissionProfileCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateMissionProfileCommandOutput} for command's `response` shape.
33
40
  * @see {@link GroundStationClientResolvedConfig | config} for GroundStationClient's `config` shape.
@@ -46,11 +53,20 @@ export interface CreateMissionProfileCommandOutput extends MissionProfileIdRespo
46
53
  export declare class CreateMissionProfileCommand extends $Command<CreateMissionProfileCommandInput, CreateMissionProfileCommandOutput, GroundStationClientResolvedConfig> {
47
54
  readonly input: CreateMissionProfileCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: CreateMissionProfileCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GroundStationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateMissionProfileCommandInput, CreateMissionProfileCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GroundStationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GroundStationClient";
5
5
  import { ConfigIdResponse, DeleteConfigRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteConfigCommand}.
8
10
  */
9
11
  export interface DeleteConfigCommandInput extends DeleteConfigRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteConfigCommand}.
13
17
  */
14
18
  export interface DeleteConfigCommandOutput extends ConfigIdResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a <code>Config</code>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteConfigCommandOutput extends ConfigIdResponse, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteConfigCommandInput - {@link DeleteConfigCommandInput}
34
+ * @returns {@link DeleteConfigCommandOutput}
28
35
  * @see {@link DeleteConfigCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteConfigCommandOutput} for command's `response` shape.
30
37
  * @see {@link GroundStationClientResolvedConfig | config} for GroundStationClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DeleteConfigCommandOutput extends ConfigIdResponse, __MetadataB
43
50
  export declare class DeleteConfigCommand extends $Command<DeleteConfigCommandInput, DeleteConfigCommandOutput, GroundStationClientResolvedConfig> {
44
51
  readonly input: DeleteConfigCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DeleteConfigCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GroundStationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteConfigCommandInput, DeleteConfigCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }