feat(client-groundstation): This release adds visibilityStartTime and…

… visibilityEndTime to DescribeContact and ListContacts responses.
aws · Apr 3, 2024 · 10f0af2 · 10f0af2
1 parent a12cf06
commit 10f0af2
Show file tree

Hide file tree

Showing 5 changed files with 86 additions and 8 deletions.
diff --git a/clients/client-groundstation/src/commands/DescribeContactCommand.ts b/clients/client-groundstation/src/commands/DescribeContactCommand.ts
@@ -183,6 +183,8 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _
  * //       errorMessage: "STRING_VALUE",
  * //     },
  * //   ],
+ * //   visibilityStartTime: new Date("TIMESTAMP"),
+ * //   visibilityEndTime: new Date("TIMESTAMP"),
  * // };
  *
  * ```

diff --git a/clients/client-groundstation/src/commands/ListContactsCommand.ts b/clients/client-groundstation/src/commands/ListContactsCommand.ts
@@ -73,6 +73,8 @@ export interface ListContactsCommandOutput extends ListContactsResponse, __Metad
  * //       tags: { // TagsMap
  * //         "<keys>": "STRING_VALUE",
  * //       },
+ * //       visibilityStartTime: new Date("TIMESTAMP"),
+ * //       visibilityEndTime: new Date("TIMESTAMP"),
  * //     },
  * //   ],
  * // };

diff --git a/clients/client-groundstation/src/models/models_0.ts b/clients/client-groundstation/src/models/models_0.ts
@@ -1775,6 +1775,28 @@ export interface DescribeContactResponse {
    * @public
    */
   dataflowList?: DataflowDetail[];
+
+  /**
+   * <p>
+   *          Projected time in UTC your satellite will rise above the
+   *          <a href="https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html">receive mask</a>.
+   *          This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was
+   *          active during contact execution for completed contacts.
+   *       </p>
+   * @public
+   */
+  visibilityStartTime?: Date;
+
+  /**
+   * <p>
+   *          Projected time in UTC your satellite will set below the
+   *          <a href="https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html">receive mask</a>.
+   *          This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was
+   *          active during contact execution for completed contacts.
+   *       </p>
+   * @public
+   */
+  visibilityEndTime?: Date;
 }
 
 /**
@@ -1913,6 +1935,30 @@ export interface ContactData {
    * @public
    */
   tags?: Record<string, string>;
+
+  /**
+   * <p>
+   *          Projected time in UTC your satellite will rise above the
+   *          <a href="https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html">receive mask</a>.
+   *          This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was
+   *          active during contact execution for completed contacts.
+   *          <i>This field is not present for contacts with a <code>SCHEDULING</code> or <code>SCHEDULED</code> status.</i>
+   *          </p>
+   * @public
+   */
+  visibilityStartTime?: Date;
+
+  /**
+   * <p>
+   *          Projected time in UTC your satellite will set below the
+   *          <a href="https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html">receive mask</a>.
+   *          This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was
+   *          active during contact execution for completed contacts.
+   *          <i>This field is not present for contacts with a <code>SCHEDULING</code> or <code>SCHEDULED</code> status.</i>
+   *          </p>
+   * @public
+   */
+  visibilityEndTime?: Date;
 }
 
 /**
@@ -2322,13 +2368,13 @@ export interface CreateMissionProfileRequest {
   name: string | undefined;
 
   /**
-   * <p>Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.</p>
+   * <p>Amount of time prior to contact start you’d like to receive a Ground Station Contact State Change event indicating an upcoming pass.</p>
    * @public
    */
   contactPrePassDurationSeconds?: number;
 
   /**
-   * <p>Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.</p>
+   * <p>Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.</p>
    * @public
    */
   contactPostPassDurationSeconds?: number;
@@ -3282,13 +3328,13 @@ export interface UpdateMissionProfileRequest {
   name?: string;
 
   /**
-   * <p>Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.</p>
+   * <p>Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.</p>
    * @public
    */
   contactPrePassDurationSeconds?: number;
 
   /**
-   * <p>Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.</p>
+   * <p>Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.</p>
    * @public
    */
   contactPostPassDurationSeconds?: number;

diff --git a/clients/client-groundstation/src/protocols/Aws_restJson1.ts b/clients/client-groundstation/src/protocols/Aws_restJson1.ts
@@ -1064,6 +1064,8 @@ export const de_DescribeContactCommand = async (
     satelliteArn: __expectString,
     startTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
     tags: _json,
+    visibilityEndTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
+    visibilityStartTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
   });
   Object.assign(contents, doc);
   return contents;
@@ -2047,6 +2049,8 @@ const de_ContactData = (output: any, context: __SerdeContext): ContactData => {
     satelliteArn: __expectString,
     startTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
     tags: _json,
+    visibilityEndTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
+    visibilityStartTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
   }) as any;
 };
 

diff --git a/codegen/sdk-codegen/aws-models/groundstation.json b/codegen/sdk-codegen/aws-models/groundstation.json
@@ -907,6 +907,18 @@
           "traits": {
             "smithy.api#documentation": "<p>Tags assigned to a contact.</p>"
           }
+        },
+        "visibilityStartTime": {
+          "target": "smithy.api#Timestamp",
+          "traits": {
+            "smithy.api#documentation": "<p>\n         Projected time in UTC your satellite will rise above the\n         <a href=\"https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html\">receive mask</a>.\n         This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was\n         active during contact execution for completed contacts.\n         <i>This field is not present for contacts with a <code>SCHEDULING</code> or <code>SCHEDULED</code> status.</i>\n         </p>"
+          }
+        },
+        "visibilityEndTime": {
+          "target": "smithy.api#Timestamp",
+          "traits": {
+            "smithy.api#documentation": "<p>\n         Projected time in UTC your satellite will set below the\n         <a href=\"https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html\">receive mask</a>.\n         This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was\n         active during contact execution for completed contacts.\n         <i>This field is not present for contacts with a <code>SCHEDULING</code> or <code>SCHEDULED</code> status.</i>\n         </p>"
+          }
         }
       },
       "traits": {
@@ -1238,13 +1250,13 @@
         "contactPrePassDurationSeconds": {
           "target": "com.amazonaws.groundstation#DurationInSeconds",
           "traits": {
-            "smithy.api#documentation": "<p>Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.</p>"
+            "smithy.api#documentation": "<p>Amount of time prior to contact start you’d like to receive a Ground Station Contact State Change event indicating an upcoming pass.</p>"
           }
         },
         "contactPostPassDurationSeconds": {
           "target": "com.amazonaws.groundstation#DurationInSeconds",
           "traits": {
-            "smithy.api#documentation": "<p>Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.</p>"
+            "smithy.api#documentation": "<p>Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.</p>"
           }
         },
         "minimumViableContactDurationSeconds": {
@@ -1899,6 +1911,18 @@
           "traits": {
             "smithy.api#documentation": "<p>List describing source and destination details for each dataflow edge.</p>"
           }
+        },
+        "visibilityStartTime": {
+          "target": "smithy.api#Timestamp",
+          "traits": {
+            "smithy.api#documentation": "<p>\n         Projected time in UTC your satellite will rise above the\n         <a href=\"https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html\">receive mask</a>.\n         This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was\n         active during contact execution for completed contacts.\n      </p>"
+          }
+        },
+        "visibilityEndTime": {
+          "target": "smithy.api#Timestamp",
+          "traits": {
+            "smithy.api#documentation": "<p>\n         Projected time in UTC your satellite will set below the\n         <a href=\"https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html\">receive mask</a>.\n         This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was\n         active during contact execution for completed contacts.\n      </p>"
+          }
         }
       },
       "traits": {
@@ -6064,13 +6088,13 @@
         "contactPrePassDurationSeconds": {
           "target": "com.amazonaws.groundstation#DurationInSeconds",
           "traits": {
-            "smithy.api#documentation": "<p>Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.</p>"
+            "smithy.api#documentation": "<p>Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.</p>"
           }
         },
         "contactPostPassDurationSeconds": {
           "target": "com.amazonaws.groundstation#DurationInSeconds",
           "traits": {
-            "smithy.api#documentation": "<p>Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.</p>"
+            "smithy.api#documentation": "<p>Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.</p>"
           }
         },
         "minimumViableContactDurationSeconds": {
-Original file line number
+Diff line change
@@ Expand Up @@
      * //       errorMessage: "STRING_VALUE",
      * //     },
      * //   ],
+     * //   visibilityStartTime: new Date("TIMESTAMP"),
+     * //   visibilityEndTime: new Date("TIMESTAMP"),
      * // };
      *
      * ```
@@ Expand Down @@