@aws-sdk/client-groundstation 3.202.0 → 3.207.0

package/dist-types/models/models_0.d.ts

@@ -669,7 +669,7 @@ export interface SecurityDetails {
  */
 export interface EndpointDetails {
     /**
-     * <p>Endpoint security details.</p>
+     * <p>Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.</p>
      */
     securityDetails?: SecurityDetails;
     /**
@@ -686,7 +686,7 @@ export interface S3RecordingDetails {
      */
     bucketArn?: string;
     /**
-     * <p>Template of the S3 key used.</p>
+     * <p>Key template used for the S3 Recording Configuration</p>
      */
     keyTemplate?: string;
 }
@@ -794,7 +794,8 @@ export interface Source {
      */
     configId?: string;
     /**
-     * <p>Additional details for a <code>Config</code>, if type is dataflow endpoint or antenna demod decode.</p>
+     * <p>Additional details for a <code>Config</code>, if type is <code>dataflow-endpoint</code> or <code>antenna-downlink-demod-decode</code>
+     *          </p>
      */
     configDetails?: ConfigDetails;
     /**
@@ -849,11 +850,11 @@ export interface DescribeContactResponse {
      */
     satelliteArn?: string;
     /**
-     * <p>Start time of a contact.</p>
+     * <p>Start time of a contact in UTC.</p>
      */
     startTime?: Date;
     /**
-     * <p>End time of a contact.</p>
+     * <p>End time of a contact in UTC.</p>
      */
     endTime?: Date;
     /**
@@ -910,11 +911,11 @@ export interface ListContactsRequest {
      */
     statusList: (ContactStatus | string)[] | undefined;
     /**
-     * <p>Start time of a contact.</p>
+     * <p>Start time of a contact in UTC.</p>
      */
     startTime: Date | undefined;
     /**
-     * <p>End time of a contact.</p>
+     * <p>End time of a contact in UTC.</p>
      */
     endTime: Date | undefined;
     /**
@@ -947,11 +948,11 @@ export interface ContactData {
      */
     satelliteArn?: string;
     /**
-     * <p>Start time of a contact.</p>
+     * <p>Start time of a contact in UTC.</p>
      */
     startTime?: Date;
     /**
-     * <p>End time of a contact.</p>
+     * <p>End time of a contact in UTC.</p>
      */
     endTime?: Date;
     /**
@@ -1013,11 +1014,11 @@ export interface ReserveContactRequest {
      */
     satelliteArn: string | undefined;
     /**
-     * <p>Start time of a contact.</p>
+     * <p>Start time of a contact in UTC.</p>
      */
     startTime: Date | undefined;
     /**
-     * <p>End time of a contact.</p>
+     * <p>End time of a contact in UTC.</p>
      */
     endTime: Date | undefined;
     /**
@@ -1051,6 +1052,155 @@ export interface DataflowEndpointGroupIdResponse {
      */
     dataflowEndpointGroupId?: string;
 }
+/**
+ * <p>Object stored in S3 containing ephemeris data.</p>
+ */
+export interface S3Object {
+    /**
+     * <p>An Amazon S3 Bucket name.</p>
+     */
+    bucket?: string;
+    /**
+     * <p>An Amazon S3 key for the ephemeris.</p>
+     */
+    key?: string;
+    /**
+     * <p>For versioned S3 objects, the version to use for the ephemeris.</p>
+     */
+    version?: string;
+}
+/**
+ * <p>Ephemeris data in Orbit Ephemeris Message (OEM) format.</p>
+ */
+export interface OEMEphemeris {
+    /**
+     * <p>Identifies the S3 object to be used as the ephemeris.</p>
+     */
+    s3Object?: S3Object;
+    /**
+     * <p>The data for an OEM ephemeris, supplied directly in the request rather than through an S3 object.</p>
+     */
+    oemData?: string;
+}
+/**
+ * <p>A time range with a start and end time.</p>
+ */
+export interface TimeRange {
+    /**
+     * <p>Time in UTC at which the time range starts.</p>
+     */
+    startTime: Date | undefined;
+    /**
+     * <p>Time in UTC at which the time range ends.</p>
+     */
+    endTime: Date | undefined;
+}
+/**
+ * <p>Two-line element set (TLE) data.</p>
+ */
+export interface TLEData {
+    /**
+     * <p>First line of two-line element set (TLE) data.</p>
+     */
+    tleLine1: string | undefined;
+    /**
+     * <p>Second line of two-line element set (TLE) data.</p>
+     */
+    tleLine2: string | undefined;
+    /**
+     * <p>The valid time range for the TLE. Gaps or overlap are not permitted.</p>
+     */
+    validTimeRange: TimeRange | undefined;
+}
+/**
+ * <p>Two-line element set (TLE) ephemeris.</p>
+ */
+export interface TLEEphemeris {
+    /**
+     * <p>Identifies the S3 object to be used as the ephemeris.</p>
+     */
+    s3Object?: S3Object;
+    /**
+     * <p>The data for a TLE ephemeris, supplied directly in the request rather than through an S3 object.</p>
+     */
+    tleData?: TLEData[];
+}
+/**
+ * <p>Ephemeris data.</p>
+ */
+export declare type EphemerisData = EphemerisData.OemMember | EphemerisData.TleMember | EphemerisData.$UnknownMember;
+export declare namespace EphemerisData {
+    /**
+     * <p>Two-line element set (TLE) ephemeris.</p>
+     */
+    interface TleMember {
+        tle: TLEEphemeris;
+        oem?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Ephemeris data in Orbit Ephemeris Message (OEM) format.</p>
+     */
+    interface OemMember {
+        tle?: never;
+        oem: OEMEphemeris;
+        $unknown?: never;
+    }
+    interface $UnknownMember {
+        tle?: never;
+        oem?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        tle: (value: TLEEphemeris) => T;
+        oem: (value: OEMEphemeris) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: EphemerisData, visitor: Visitor<T>) => T;
+}
+export interface CreateEphemerisRequest {
+    /**
+     * <p>AWS Ground Station satellite ID for this ephemeris.</p>
+     */
+    satelliteId: string | undefined;
+    /**
+     * <p>Whether to set the ephemeris status to <code>ENABLED</code> after validation.</p>
+     *         <p>Setting this to false will set the ephemeris status to <code>DISABLED</code> after validation.</p>
+     */
+    enabled?: boolean;
+    /**
+     * <p>Customer-provided priority score to establish the order in which overlapping ephemerides should be used.</p>
+     *         <p>The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.</p>
+     *         <p>Priority must be 1 or greater</p>
+     */
+    priority?: number;
+    /**
+     * <p>An overall expiration time for the ephemeris in UTC, after which it will become <code>EXPIRED</code>.</p>
+     */
+    expirationTime?: Date;
+    /**
+     * <p>A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.</p>
+     */
+    name: string | undefined;
+    /**
+     * <p>The ARN of a KMS key used to encrypt the ephemeris in Ground Station.</p>
+     */
+    kmsKeyArn?: string;
+    /**
+     * <p>Ephemeris data.</p>
+     */
+    ephemeris?: EphemerisData;
+    /**
+     * <p>Tags assigned to an ephemeris.</p>
+     */
+    tags?: Record<string, string>;
+}
+export interface EphemerisIdResponse {
+    /**
+     * <p>The AWS Ground Station ephemeris ID.</p>
+     */
+    ephemerisId?: string;
+}
 /**
  * <p/>
  */
@@ -1173,6 +1323,12 @@ export interface ListDataflowEndpointGroupsResponse {
      */
     dataflowEndpointGroupList?: DataflowEndpointListItem[];
 }
+export interface DeleteEphemerisRequest {
+    /**
+     * <p>The AWS Ground Station ephemeris ID.</p>
+     */
+    ephemerisId: string | undefined;
+}
 /**
  * <p/>
  */
@@ -1182,6 +1338,251 @@ export interface DeleteMissionProfileRequest {
      */
     missionProfileId: string | undefined;
 }
+export interface DescribeEphemerisRequest {
+    /**
+     * <p>The AWS Ground Station ephemeris ID.</p>
+     */
+    ephemerisId: string | undefined;
+}
+export declare enum EphemerisInvalidReason {
+    /**
+     * Provided KMS key is invalid
+     */
+    KMS_KEY_INVALID = "KMS_KEY_INVALID",
+    /**
+     * Provided spacecraft identifiers such as spacecraft NORAD Id are invalid
+     */
+    METADATA_INVALID = "METADATA_INVALID",
+    /**
+     * Start, end, or expiration time(s) are invalid for the provided ephemeris
+     */
+    TIME_RANGE_INVALID = "TIME_RANGE_INVALID",
+    /**
+     * Provided ephemeris defines invalid spacecraft trajectory
+     */
+    TRAJECTORY_INVALID = "TRAJECTORY_INVALID",
+    /**
+     * Internal Service Error occurred while processing ephemeris
+     */
+    VALIDATION_ERROR = "VALIDATION_ERROR"
+}
+export declare enum EphemerisStatus {
+    DISABLED = "DISABLED",
+    ENABLED = "ENABLED",
+    ERROR = "ERROR",
+    EXPIRED = "EXPIRED",
+    INVALID = "INVALID",
+    VALIDATING = "VALIDATING"
+}
+/**
+ * <p>Description of ephemeris.</p>
+ */
+export interface EphemerisDescription {
+    /**
+     * <p>Source S3 object used for the ephemeris.</p>
+     */
+    sourceS3Object?: S3Object;
+    /**
+     * <p>Supplied ephemeris data.</p>
+     */
+    ephemerisData?: string;
+}
+/**
+ * <p/>
+ */
+export declare type EphemerisTypeDescription = EphemerisTypeDescription.OemMember | EphemerisTypeDescription.TleMember | EphemerisTypeDescription.$UnknownMember;
+export declare namespace EphemerisTypeDescription {
+    /**
+     * <p>Description of ephemeris.</p>
+     */
+    interface TleMember {
+        tle: EphemerisDescription;
+        oem?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Description of ephemeris.</p>
+     */
+    interface OemMember {
+        tle?: never;
+        oem: EphemerisDescription;
+        $unknown?: never;
+    }
+    interface $UnknownMember {
+        tle?: never;
+        oem?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        tle: (value: EphemerisDescription) => T;
+        oem: (value: EphemerisDescription) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: EphemerisTypeDescription, visitor: Visitor<T>) => T;
+}
+export interface DescribeEphemerisResponse {
+    /**
+     * <p>The AWS Ground Station ephemeris ID.</p>
+     */
+    ephemerisId?: string;
+    /**
+     * <p>The AWS Ground Station satellite ID associated with ephemeris.</p>
+     */
+    satelliteId?: string;
+    /**
+     * <p>The status of the ephemeris.</p>
+     */
+    status?: EphemerisStatus | string;
+    /**
+     * <p>Customer-provided priority score to establish the order in which overlapping ephemerides should be used.</p>
+     *         <p>The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.</p>
+     *         <p>Priority must be 1 or greater</p>
+     */
+    priority?: number;
+    /**
+     * <p>The time the ephemeris was uploaded in UTC.</p>
+     */
+    creationTime?: Date;
+    /**
+     * <p>Whether or not the ephemeris is enabled.</p>
+     */
+    enabled?: boolean;
+    /**
+     * <p>A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.</p>
+     */
+    name?: string;
+    /**
+     * <p>Tags assigned to an ephemeris.</p>
+     */
+    tags?: Record<string, string>;
+    /**
+     * <p>Supplied ephemeris data.</p>
+     */
+    suppliedData?: EphemerisTypeDescription;
+    /**
+     * <p>Reason that an ephemeris failed validation. Only provided for ephemerides with <code>INVALID</code> status.</p>
+     */
+    invalidReason?: EphemerisInvalidReason | string;
+}
+/**
+ * <p>Ephemeris item.</p>
+ */
+export interface EphemerisItem {
+    /**
+     * <p>The AWS Ground Station ephemeris ID.</p>
+     */
+    ephemerisId?: string;
+    /**
+     * <p>The status of the ephemeris.</p>
+     */
+    status?: EphemerisStatus | string;
+    /**
+     * <p>Customer-provided priority score to establish the order in which overlapping ephemerides should be used.</p>
+     *         <p>The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.</p>
+     *         <p>Priority must be 1 or greater</p>
+     */
+    priority?: number;
+    /**
+     * <p>Whether or not the ephemeris is enabled.</p>
+     */
+    enabled?: boolean;
+    /**
+     * <p>The time the ephemeris was uploaded in UTC.</p>
+     */
+    creationTime?: Date;
+    /**
+     * <p>A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.</p>
+     */
+    name?: string;
+    /**
+     * <p>Source S3 object used for the ephemeris.</p>
+     */
+    sourceS3Object?: S3Object;
+}
+export interface ListEphemeridesRequest {
+    /**
+     * <p>The AWS Ground Station satellite ID to list ephemeris for.</p>
+     */
+    satelliteId: string | undefined;
+    /**
+     * <p>The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the <code>startTime</code> and <code>endTime</code>.</p>
+     */
+    startTime: Date | undefined;
+    /**
+     * <p>The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the <code>startTime</code> and <code>endTime</code>.</p>
+     */
+    endTime: Date | undefined;
+    /**
+     * <p>The list of ephemeris status to return.</p>
+     */
+    statusList?: (EphemerisStatus | string)[];
+    /**
+     * <p>Maximum number of ephemerides to return.</p>
+     */
+    maxResults?: number;
+    /**
+     * <p>Pagination token.</p>
+     */
+    nextToken?: string;
+}
+export interface ListEphemeridesResponse {
+    /**
+     * <p>Pagination token.</p>
+     */
+    nextToken?: string;
+    /**
+     * <p>List of ephemerides.</p>
+     */
+    ephemerides?: EphemerisItem[];
+}
+export interface UpdateEphemerisRequest {
+    /**
+     * <p>The AWS Ground Station ephemeris ID.</p>
+     */
+    ephemerisId: string | undefined;
+    /**
+     * <p>Whether the ephemeris is enabled or not. Changing this value will not require the ephemeris to be re-validated.</p>
+     */
+    enabled: boolean | undefined;
+    /**
+     * <p>A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.</p>
+     */
+    name?: string;
+    /**
+     * <p>Customer-provided priority score to establish the order in which overlapping ephemerides should be used.</p>
+     *         <p>The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.</p>
+     *         <p>Priority must be 1 or greater</p>
+     */
+    priority?: number;
+}
+export declare enum EphemerisSource {
+    CUSTOMER_PROVIDED = "CUSTOMER_PROVIDED",
+    SPACE_TRACK = "SPACE_TRACK"
+}
+/**
+ * <p>Metadata describing a particular ephemeris.</p>
+ */
+export interface EphemerisMetaData {
+    /**
+     * <p>The <code>EphemerisSource</code> that generated a given ephemeris.</p>
+     */
+    source: EphemerisSource | string | undefined;
+    /**
+     * <p>UUID of a customer-provided ephemeris.</p>
+     *         <p>This field is not populated for default ephemerides from Space Track.</p>
+     */
+    ephemerisId?: string;
+    /**
+     * <p>The epoch of a default, ephemeris from Space Track in UTC.</p>
+     *         <p>This field is not populated for customer-provided ephemerides.</p>
+     */
+    epoch?: Date;
+    /**
+     * <p>A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.</p>
+     *         <p>A name is only returned for customer-provider ephemerides that have a name associated.</p>
+     */
+    name?: string;
+}
 /**
  * <p/>
  */
@@ -1305,6 +1706,10 @@ export interface GetSatelliteResponse {
      * <p>A list of ground stations to which the satellite is on-boarded.</p>
      */
     groundStations?: string[];
+    /**
+     * <p>The current ephemeris being used to compute the trajectory of the satellite.</p>
+     */
+    currentEphemeris?: EphemerisMetaData;
 }
 /**
  * <p/>
@@ -1486,6 +1891,10 @@ export interface SatelliteListItem {
      * <p>A list of ground stations to which the satellite is on-boarded.</p>
      */
     groundStations?: string[];
+    /**
+     * <p>The current ephemeris being used to compute the trajectory of the satellite.</p>
+     */
+    currentEphemeris?: EphemerisMetaData;
 }
 /**
  * <p/>
@@ -1716,6 +2125,38 @@ export declare const CreateDataflowEndpointGroupRequestFilterSensitiveLog: (obj:
  * @internal
  */
 export declare const DataflowEndpointGroupIdResponseFilterSensitiveLog: (obj: DataflowEndpointGroupIdResponse) => any;
+/**
+ * @internal
+ */
+export declare const S3ObjectFilterSensitiveLog: (obj: S3Object) => any;
+/**
+ * @internal
+ */
+export declare const OEMEphemerisFilterSensitiveLog: (obj: OEMEphemeris) => any;
+/**
+ * @internal
+ */
+export declare const TimeRangeFilterSensitiveLog: (obj: TimeRange) => any;
+/**
+ * @internal
+ */
+export declare const TLEDataFilterSensitiveLog: (obj: TLEData) => any;
+/**
+ * @internal
+ */
+export declare const TLEEphemerisFilterSensitiveLog: (obj: TLEEphemeris) => any;
+/**
+ * @internal
+ */
+export declare const EphemerisDataFilterSensitiveLog: (obj: EphemerisData) => any;
+/**
+ * @internal
+ */
+export declare const CreateEphemerisRequestFilterSensitiveLog: (obj: CreateEphemerisRequest) => any;
+/**
+ * @internal
+ */
+export declare const EphemerisIdResponseFilterSensitiveLog: (obj: EphemerisIdResponse) => any;
 /**
  * @internal
  */
@@ -1748,10 +2189,50 @@ export declare const DataflowEndpointListItemFilterSensitiveLog: (obj: DataflowE
  * @internal
  */
 export declare const ListDataflowEndpointGroupsResponseFilterSensitiveLog: (obj: ListDataflowEndpointGroupsResponse) => any;
+/**
+ * @internal
+ */
+export declare const DeleteEphemerisRequestFilterSensitiveLog: (obj: DeleteEphemerisRequest) => any;
 /**
  * @internal
  */
 export declare const DeleteMissionProfileRequestFilterSensitiveLog: (obj: DeleteMissionProfileRequest) => any;
+/**
+ * @internal
+ */
+export declare const DescribeEphemerisRequestFilterSensitiveLog: (obj: DescribeEphemerisRequest) => any;
+/**
+ * @internal
+ */
+export declare const EphemerisDescriptionFilterSensitiveLog: (obj: EphemerisDescription) => any;
+/**
+ * @internal
+ */
+export declare const EphemerisTypeDescriptionFilterSensitiveLog: (obj: EphemerisTypeDescription) => any;
+/**
+ * @internal
+ */
+export declare const DescribeEphemerisResponseFilterSensitiveLog: (obj: DescribeEphemerisResponse) => any;
+/**
+ * @internal
+ */
+export declare const EphemerisItemFilterSensitiveLog: (obj: EphemerisItem) => any;
+/**
+ * @internal
+ */
+export declare const ListEphemeridesRequestFilterSensitiveLog: (obj: ListEphemeridesRequest) => any;
+/**
+ * @internal
+ */
+export declare const ListEphemeridesResponseFilterSensitiveLog: (obj: ListEphemeridesResponse) => any;
+/**
+ * @internal
+ */
+export declare const UpdateEphemerisRequestFilterSensitiveLog: (obj: UpdateEphemerisRequest) => any;
+/**
+ * @internal
+ */
+export declare const EphemerisMetaDataFilterSensitiveLog: (obj: EphemerisMetaData) => any;
 /**
  * @internal
  */

package/dist-types/pagination/ListEphemeridesPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListEphemeridesCommandInput, ListEphemeridesCommandOutput } from "../commands/ListEphemeridesCommand";
+import { GroundStationPaginationConfiguration } from "./Interfaces";
+export declare function paginateListEphemerides(config: GroundStationPaginationConfiguration, input: ListEphemeridesCommandInput, ...additionalArguments: any): Paginator<ListEphemeridesCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -2,6 +2,7 @@ export * from "./Interfaces";
 export * from "./ListConfigsPaginator";
 export * from "./ListContactsPaginator";
 export * from "./ListDataflowEndpointGroupsPaginator";
+export * from "./ListEphemeridesPaginator";
 export * from "./ListGroundStationsPaginator";
 export * from "./ListMissionProfilesPaginator";
 export * from "./ListSatellitesPaginator";