@aws-sdk/client-groundstation 3.918.0 → 3.920.0

package/dist-types/GroundStationClient.d.ts

@@ -202,10 +202,7 @@ export type GroundStationClientResolvedConfigType = __SmithyResolvedConfiguratio
 export interface GroundStationClientResolvedConfig extends GroundStationClientResolvedConfigType {
 }
 /**
- * <p>Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that
- *       enables you to control satellite communications, downlink and process satellite data, and
- *       scale your satellite operations efficiently and cost-effectively without having
- *       to build or manage your own ground station infrastructure.</p>
+ * <p>Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that enables you to control satellite communications, downlink and process satellite data, and scale your satellite operations efficiently and cost-effectively without having to build or manage your own ground station infrastructure.</p>
  * @public
  */
 export declare class GroundStationClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, GroundStationClientResolvedConfig> {

package/dist-types/commands/CreateConfigCommand.d.ts

@@ -27,8 +27,7 @@ declare const CreateConfigCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Creates a <code>Config</code> with the specified <code>configData</code> parameters.</p>
- *          <p>Only one type of <code>configData</code> can be specified.</p>
+ * <p>Creates a <code>Config</code> with the specified <code>configData</code> parameters.</p> <p>Only one type of <code>configData</code> can be specified.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/CreateDataflowEndpointGroupCommand.d.ts

@@ -27,11 +27,7 @@ declare const CreateDataflowEndpointGroupCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Creates a <code>DataflowEndpoint</code> group containing the specified list of <code>DataflowEndpoint</code> objects.</p>
- *          <p>The <code>name</code> field in each endpoint is used in your mission profile <code>DataflowEndpointConfig</code>
- *          to specify which endpoints to use during a contact.</p>
- *          <p>When a contact uses multiple <code>DataflowEndpointConfig</code> objects, each <code>Config</code>
- *          must match a <code>DataflowEndpoint</code> in the same group.</p>
+ * <p>Creates a <code>DataflowEndpoint</code> group containing the specified list of <code>DataflowEndpoint</code> objects.</p> <p>The <code>name</code> field in each endpoint is used in your mission profile <code>DataflowEndpointConfig</code> to specify which endpoints to use during a contact.</p> <p>When a contact uses multiple <code>DataflowEndpointConfig</code> objects, each <code>Config</code> must match a <code>DataflowEndpoint</code> in the same group.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/CreateEphemerisCommand.d.ts

@@ -27,7 +27,7 @@ declare const CreateEphemerisCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Creates an Ephemeris with the specified <code>EphemerisData</code>.</p>
+ * <p>Create an ephemeris with your specified <a>EphemerisData</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -37,7 +37,7 @@ declare const CreateEphemerisCommand_base: {
  * const config = {}; // type is GroundStationClientConfig
  * const client = new GroundStationClient(config);
  * const input = { // CreateEphemerisRequest
- *   satelliteId: "STRING_VALUE", // required
+ *   satelliteId: "STRING_VALUE",
  *   enabled: true || false,
  *   priority: Number("int"),
  *   expirationTime: new Date("TIMESTAMP"),
@@ -69,6 +69,35 @@ declare const CreateEphemerisCommand_base: {
  *       },
  *       oemData: "STRING_VALUE",
  *     },
+ *     azEl: { // AzElEphemeris
+ *       groundStation: "STRING_VALUE", // required
+ *       data: { // AzElSegmentsData Union: only one key present
+ *         s3Object: {
+ *           bucket: "STRING_VALUE",
+ *           key: "STRING_VALUE",
+ *           version: "STRING_VALUE",
+ *         },
+ *         azElData: { // AzElSegments
+ *           angleUnit: "DEGREE_ANGLE" || "RADIAN", // required
+ *           azElSegmentList: [ // AzElSegmentList // required
+ *             { // AzElSegment
+ *               referenceEpoch: new Date("TIMESTAMP"), // required
+ *               validTimeRange: { // ISO8601TimeRange
+ *                 startTime: new Date("TIMESTAMP"), // required
+ *                 endTime: new Date("TIMESTAMP"), // required
+ *               },
+ *               azElList: [ // TimeAzElList // required
+ *                 { // TimeAzEl
+ *                   dt: Number("double"), // required
+ *                   az: Number("double"), // required
+ *                   el: Number("double"), // required
+ *                 },
+ *               ],
+ *             },
+ *           ],
+ *         },
+ *       },
+ *     },
  *   },
  *   tags: { // TagsMap
  *     "<keys>": "STRING_VALUE",

package/dist-types/commands/CreateMissionProfileCommand.d.ts

@@ -27,10 +27,7 @@ declare const CreateMissionProfileCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Creates a mission profile.</p>
- *          <p>
- *             <code>dataflowEdges</code> is a list of lists of strings. Each lower level list of strings
- *          has two elements: a <i>from</i> ARN and a <i>to</i> ARN.</p>
+ * <p>Creates a mission profile.</p> <p> <code>dataflowEdges</code> is a list of lists of strings. Each lower level list of strings has two elements: a <i>from</i> ARN and a <i>to</i> ARN.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/DeleteEphemerisCommand.d.ts

@@ -27,7 +27,7 @@ declare const DeleteEphemerisCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes an ephemeris</p>
+ * <p>Delete an ephemeris.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -59,6 +59,9 @@ declare const DeleteEphemerisCommand_base: {
  * @throws {@link InvalidParameterException} (client fault)
  *  <p>One or more parameters are not valid.</p>
  *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The specified resource is in use by non-terminal state contacts and cannot be modified or deleted.</p>
+ *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>Resource was not found.</p>
  *

package/dist-types/commands/DescribeContactCommand.d.ts

@@ -187,6 +187,17 @@ declare const DescribeContactCommand_base: {
  * //   ],
  * //   visibilityStartTime: new Date("TIMESTAMP"),
  * //   visibilityEndTime: new Date("TIMESTAMP"),
+ * //   trackingOverrides: { // TrackingOverrides
+ * //     programTrackSettings: { // ProgramTrackSettings Union: only one key present
+ * //       azEl: { // AzElProgramTrackSettings
+ * //         ephemerisId: "STRING_VALUE", // required
+ * //       },
+ * //     },
+ * //   },
+ * //   ephemeris: { // EphemerisResponseData
+ * //     ephemerisId: "STRING_VALUE",
+ * //     ephemerisType: "TLE" || "OEM" || "AZ_EL" || "SERVICE_MANAGED", // required
+ * //   },
  * // };
  *
  * ```

package/dist-types/commands/DescribeEphemerisCommand.d.ts

@@ -27,7 +27,7 @@ declare const DescribeEphemerisCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Describes an existing ephemeris.</p>
+ * <p>Retrieve information about an existing ephemeris.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -69,8 +69,22 @@ declare const DescribeEphemerisCommand_base: {
  * //       },
  * //       ephemerisData: "STRING_VALUE",
  * //     },
+ * //     azEl: {
+ * //       sourceS3Object: {
+ * //         bucket: "STRING_VALUE",
+ * //         key: "STRING_VALUE",
+ * //         version: "STRING_VALUE",
+ * //       },
+ * //       ephemerisData: "STRING_VALUE",
+ * //     },
  * //   },
  * //   invalidReason: "METADATA_INVALID" || "TIME_RANGE_INVALID" || "TRAJECTORY_INVALID" || "KMS_KEY_INVALID" || "VALIDATION_ERROR",
+ * //   errorReasons: [ // EphemerisErrorReasonList
+ * //     { // EphemerisErrorReason
+ * //       errorCode: "INTERNAL_ERROR" || "MISMATCHED_SATCAT_ID" || "OEM_VERSION_UNSUPPORTED" || "ORIGINATOR_MISSING" || "CREATION_DATE_MISSING" || "OBJECT_NAME_MISSING" || "OBJECT_ID_MISSING" || "REF_FRAME_UNSUPPORTED" || "REF_FRAME_EPOCH_UNSUPPORTED" || "TIME_SYSTEM_UNSUPPORTED" || "CENTER_BODY_UNSUPPORTED" || "INTERPOLATION_MISSING" || "INTERPOLATION_DEGREE_INVALID" || "AZ_EL_SEGMENT_LIST_MISSING" || "INSUFFICIENT_TIME_AZ_EL" || "START_TIME_IN_FUTURE" || "END_TIME_IN_PAST" || "EXPIRATION_TIME_TOO_EARLY" || "START_TIME_METADATA_TOO_EARLY" || "STOP_TIME_METADATA_TOO_LATE" || "AZ_EL_SEGMENT_END_TIME_BEFORE_START_TIME" || "AZ_EL_SEGMENT_TIMES_OVERLAP" || "AZ_EL_SEGMENTS_OUT_OF_ORDER" || "TIME_AZ_EL_ITEMS_OUT_OF_ORDER" || "MEAN_MOTION_INVALID" || "TIME_AZ_EL_AZ_RADIAN_RANGE_INVALID" || "TIME_AZ_EL_EL_RADIAN_RANGE_INVALID" || "TIME_AZ_EL_AZ_DEGREE_RANGE_INVALID" || "TIME_AZ_EL_EL_DEGREE_RANGE_INVALID" || "TIME_AZ_EL_ANGLE_UNITS_INVALID" || "INSUFFICIENT_KMS_PERMISSIONS" || "FILE_FORMAT_INVALID" || "AZ_EL_SEGMENT_REFERENCE_EPOCH_INVALID" || "AZ_EL_SEGMENT_START_TIME_INVALID" || "AZ_EL_SEGMENT_END_TIME_INVALID" || "AZ_EL_SEGMENT_VALID_TIME_RANGE_INVALID" || "AZ_EL_SEGMENT_END_TIME_TOO_LATE" || "AZ_EL_TOTAL_DURATION_EXCEEDED", // required
+ * //       errorMessage: "STRING_VALUE", // required
+ * //     },
+ * //   ],
  * // };
  *
  * ```

package/dist-types/commands/GetAgentConfigurationCommand.d.ts

@@ -27,10 +27,7 @@ declare const GetAgentConfigurationCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <note>
- *             <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
- *          </note>
- *          <p>Gets the latest configuration information for a registered agent.</p>
+ * <note> <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p> </note> <p>Gets the latest configuration information for a registered agent.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/GetConfigCommand.d.ts

@@ -27,8 +27,7 @@ declare const GetConfigCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns <code>Config</code> information.</p>
- *          <p>Only one <code>Config</code> response can be returned.</p>
+ * <p>Returns <code>Config</code> information.</p> <p>Only one <code>Config</code> response can be returned.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListContactsCommand.d.ts

@@ -27,10 +27,7 @@ declare const ListContactsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of contacts.</p>
- *          <p>If <code>statusList</code> contains AVAILABLE, the request must include
- *       <code>groundStation</code>, <code>missionprofileArn</code>, and <code>satelliteArn</code>.
- *       </p>
+ * <p>Returns a list of contacts.</p> <p>If <code>statusList</code> contains AVAILABLE, the request must include <code>groundStation</code>, <code>missionprofileArn</code>, and <code>satelliteArn</code>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -50,6 +47,11 @@ declare const ListContactsCommand_base: {
  *   groundStation: "STRING_VALUE",
  *   satelliteArn: "STRING_VALUE",
  *   missionProfileArn: "STRING_VALUE",
+ *   ephemeris: { // EphemerisFilter Union: only one key present
+ *     azEl: { // AzElEphemerisFilter
+ *       id: "STRING_VALUE", // required
+ *     },
+ *   },
  * };
  * const command = new ListContactsCommand(input);
  * const response = await client.send(command);
@@ -77,6 +79,10 @@ declare const ListContactsCommand_base: {
  * //       },
  * //       visibilityStartTime: new Date("TIMESTAMP"),
  * //       visibilityEndTime: new Date("TIMESTAMP"),
+ * //       ephemeris: { // EphemerisResponseData
+ * //         ephemerisId: "STRING_VALUE",
+ * //         ephemerisType: "TLE" || "OEM" || "AZ_EL" || "SERVICE_MANAGED", // required
+ * //       },
  * //     },
  * //   ],
  * // };

package/dist-types/commands/ListEphemeridesCommand.d.ts

@@ -27,7 +27,7 @@ declare const ListEphemeridesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>List existing ephemerides.</p>
+ * <p>List your existing ephemerides.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -37,7 +37,8 @@ declare const ListEphemeridesCommand_base: {
  * const config = {}; // type is GroundStationClientConfig
  * const client = new GroundStationClient(config);
  * const input = { // ListEphemeridesRequest
- *   satelliteId: "STRING_VALUE", // required
+ *   satelliteId: "STRING_VALUE",
+ *   ephemerisType: "TLE" || "OEM" || "AZ_EL" || "SERVICE_MANAGED",
  *   startTime: new Date("TIMESTAMP"), // required
  *   endTime: new Date("TIMESTAMP"), // required
  *   statusList: [ // EphemerisStatusList
@@ -53,6 +54,7 @@ declare const ListEphemeridesCommand_base: {
  * //   ephemerides: [ // EphemeridesList
  * //     { // EphemerisItem
  * //       ephemerisId: "STRING_VALUE",
+ * //       ephemerisType: "TLE" || "OEM" || "AZ_EL" || "SERVICE_MANAGED",
  * //       status: "VALIDATING" || "INVALID" || "ERROR" || "ENABLED" || "DISABLED" || "EXPIRED",
  * //       priority: Number("int"),
  * //       enabled: true || false,

package/dist-types/commands/RegisterAgentCommand.d.ts

@@ -27,10 +27,7 @@ declare const RegisterAgentCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <note>
- *             <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
- *          </note>
- *          <p> Registers a new agent with AWS Ground Station. </p>
+ * <note> <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p> </note> <p> Registers a new agent with AWS Ground Station. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ReserveContactCommand.d.ts

@@ -38,13 +38,20 @@ declare const ReserveContactCommand_base: {
  * const client = new GroundStationClient(config);
  * const input = { // ReserveContactRequest
  *   missionProfileArn: "STRING_VALUE", // required
- *   satelliteArn: "STRING_VALUE", // required
+ *   satelliteArn: "STRING_VALUE",
  *   startTime: new Date("TIMESTAMP"), // required
  *   endTime: new Date("TIMESTAMP"), // required
  *   groundStation: "STRING_VALUE", // required
  *   tags: { // TagsMap
  *     "<keys>": "STRING_VALUE",
  *   },
+ *   trackingOverrides: { // TrackingOverrides
+ *     programTrackSettings: { // ProgramTrackSettings Union: only one key present
+ *       azEl: { // AzElProgramTrackSettings
+ *         ephemerisId: "STRING_VALUE", // required
+ *       },
+ *     },
+ *   },
  * };
  * const command = new ReserveContactCommand(input);
  * const response = await client.send(command);
@@ -66,6 +73,9 @@ declare const ReserveContactCommand_base: {
  * @throws {@link InvalidParameterException} (client fault)
  *  <p>One or more parameters are not valid.</p>
  *
+ * @throws {@link ResourceLimitExceededException} (client fault)
+ *  <p>Account limits for this resource have been exceeded.</p>
+ *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>Resource was not found.</p>
  *

package/dist-types/commands/UpdateAgentStatusCommand.d.ts

@@ -27,10 +27,7 @@ declare const UpdateAgentStatusCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <note>
- *             <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
- *          </note>
- *          <p>Update the status of the agent.</p>
+ * <note> <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p> </note> <p>Update the status of the agent.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateConfigCommand.d.ts

@@ -27,9 +27,7 @@ declare const UpdateConfigCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates the <code>Config</code> used when scheduling contacts.</p>
- *          <p>Updating a <code>Config</code> will not update the execution parameters
- *          for existing future contacts scheduled with this <code>Config</code>.</p>
+ * <p>Updates the <code>Config</code> used when scheduling contacts.</p> <p>Updating a <code>Config</code> will not update the execution parameters for existing future contacts scheduled with this <code>Config</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateEphemerisCommand.d.ts

@@ -27,7 +27,7 @@ declare const UpdateEphemerisCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates an existing ephemeris</p>
+ * <p>Update an existing ephemeris.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateMissionProfileCommand.d.ts

@@ -27,9 +27,7 @@ declare const UpdateMissionProfileCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates a mission profile.</p>
- *          <p>Updating a mission profile will not update the execution parameters
- *          for existing future contacts.</p>
+ * <p>Updates a mission profile.</p> <p>Updating a mission profile will not update the execution parameters for existing future contacts.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/index.d.ts

@@ -1,8 +1,5 @@
 /**
- * <p>Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that
- *       enables you to control satellite communications, downlink and process satellite data, and
- *       scale your satellite operations efficiently and cost-effectively without having
- *       to build or manage your own ground station infrastructure.</p>
+ * <p>Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that enables you to control satellite communications, downlink and process satellite data, and scale your satellite operations efficiently and cost-effectively without having to build or manage your own ground station infrastructure.</p>
  *
  * @packageDocumentation
  */