feat(client-panorama): Support sorting and filtering in ListDevices API, and add more fields to device listings and single device detail

Author: awstools

clients/client-panorama/src/models/models_0.ts

@@ -1042,6 +1042,18 @@ export interface NetworkStatus {
   LastUpdatedTime?: Date;
 }
 
+export enum DeviceAggregatedStatus {
+  AWAITING_PROVISIONING = "AWAITING_PROVISIONING",
+  DELETING = "DELETING",
+  ERROR = "ERROR",
+  FAILED = "FAILED",
+  LEASE_EXPIRED = "LEASE_EXPIRED",
+  OFFLINE = "OFFLINE",
+  ONLINE = "ONLINE",
+  PENDING = "PENDING",
+  UPDATE_NEEDED = "UPDATE_NEEDED",
+}
+
 export enum DeviceConnectionStatus {
   AWAITING_CREDENTIALS = "AWAITING_CREDENTIALS",
   ERROR = "ERROR",
@@ -1050,6 +1062,31 @@ export enum DeviceConnectionStatus {
   ONLINE = "ONLINE",
 }
 
+export enum UpdateProgress {
+  COMPLETED = "COMPLETED",
+  DOWNLOADING = "DOWNLOADING",
+  FAILED = "FAILED",
+  IN_PROGRESS = "IN_PROGRESS",
+  PENDING = "PENDING",
+  REBOOTING = "REBOOTING",
+  VERIFYING = "VERIFYING",
+}
+
+/**
+ * <p>Returns information about the latest device job.</p>
+ */
+export interface LatestDeviceJob {
+  /**
+   * <p>The target version of the device software.</p>
+   */
+  ImageVersion?: string;
+
+  /**
+   * <p>Status of the latest device job.</p>
+   */
+  Status?: UpdateProgress | string;
+}
+
 /**
  * <p>A static IP configuration.</p>
  */
@@ -1225,6 +1262,16 @@ export interface DescribeDeviceResponse {
    * <p>The device's maker.</p>
    */
   Brand?: DeviceBrand | string;
+
+  /**
+   * <p>A device's latest job. Includes the target image version, and the job status.</p>
+   */
+  LatestDeviceJob?: LatestDeviceJob;
+
+  /**
+   * <p>A device's aggregated status. Including the device's connection status, provisioning status, and lease status.</p>
+   */
+  DeviceAggregatedStatus?: DeviceAggregatedStatus | string;
 }
 
 export interface DescribeDeviceJobRequest {
@@ -1234,16 +1281,6 @@ export interface DescribeDeviceJobRequest {
   JobId: string | undefined;
 }
 
-export enum UpdateProgress {
-  COMPLETED = "COMPLETED",
-  DOWNLOADING = "DOWNLOADING",
-  FAILED = "FAILED",
-  IN_PROGRESS = "IN_PROGRESS",
-  PENDING = "PENDING",
-  REBOOTING = "REBOOTING",
-  VERIFYING = "VERIFYING",
-}
-
 export interface DescribeDeviceJobResponse {
   /**
    * <p>The job's ID.</p>
@@ -1803,6 +1840,36 @@ export interface Device {
    * <p>The device's maker.</p>
    */
   Brand?: DeviceBrand | string;
+
+  /**
+   * <p>A device's current software.</p>
+   */
+  CurrentSoftware?: string;
+
+  /**
+   * <p>A description for the device.</p>
+   */
+  Description?: string;
+
+  /**
+   * <p>The device's tags.</p>
+   */
+  Tags?: Record<string, string>;
+
+  /**
+   * <p>The device's type.</p>
+   */
+  Type?: DeviceType | string;
+
+  /**
+   * <p>A device's latest job. Includes the target image version, and the update job status.</p>
+   */
+  LatestDeviceJob?: LatestDeviceJob;
+
+  /**
+   * <p>A device's aggregated status. Including the device's connection status, provisioning status, and lease status.</p>
+   */
+  DeviceAggregatedStatus?: DeviceAggregatedStatus | string;
 }
 
 /**
@@ -1998,6 +2065,18 @@ export interface ListApplicationInstancesResponse {
   NextToken?: string;
 }
 
+export enum ListDevicesSortBy {
+  CREATED_TIME = "CREATED_TIME",
+  DEVICE_AGGREGATED_STATUS = "DEVICE_AGGREGATED_STATUS",
+  DEVICE_ID = "DEVICE_ID",
+  NAME = "NAME",
+}
+
+export enum SortOrder {
+  ASCENDING = "ASCENDING",
+  DESCENDING = "DESCENDING",
+}
+
 export interface ListDevicesRequest {
   /**
    * <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
@@ -2008,6 +2087,26 @@ export interface ListDevicesRequest {
    * <p>The maximum number of devices to return in one page of results.</p>
    */
   MaxResults?: number;
+
+  /**
+   * <p>The target column to be sorted on. Default column sort is CREATED_TIME.</p>
+   */
+  SortBy?: ListDevicesSortBy | string;
+
+  /**
+   * <p>The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.</p>
+   */
+  SortOrder?: SortOrder | string;
+
+  /**
+   * <p>Filter based on device's name. Prefixes supported.</p>
+   */
+  NameFilter?: string;
+
+  /**
+   * <p>Filter based on a device's status.</p>
+   */
+  DeviceAggregatedStatusFilter?: DeviceAggregatedStatus | string;
 }
 
 export interface ListDevicesResponse {
@@ -2784,6 +2883,13 @@ export const NetworkStatusFilterSensitiveLog = (obj: NetworkStatus): any => ({
   ...obj,
 });
 
+/**
+ * @internal
+ */
+export const LatestDeviceJobFilterSensitiveLog = (obj: LatestDeviceJob): any => ({
+  ...obj,
+});
+
 /**
  * @internal
  */

clients/client-panorama/src/protocols/Aws_restJson1.ts

@@ -126,6 +126,7 @@ import {
   InternalServerException,
   Job,
   JobResourceTags,
+  LatestDeviceJob,
   ManifestOverridesPayload,
   ManifestPayload,
   NetworkPayload,
@@ -726,6 +727,10 @@ export const serializeAws_restJson1ListDevicesCommand = async (
   const query: any = map({
     NextToken: [, input.NextToken!],
     MaxResults: [() => input.MaxResults !== void 0, () => input.MaxResults!.toString()],
+    SortBy: [, input.SortBy!],
+    SortOrder: [, input.SortOrder!],
+    NameFilter: [, input.NameFilter!],
+    DeviceAggregatedStatusFilter: [, input.DeviceAggregatedStatusFilter!],
   });
   let body: any;
   return new __HttpRequest({
@@ -1675,6 +1680,9 @@ export const deserializeAws_restJson1DescribeDeviceCommand = async (
   if (data.Description != null) {
     contents.Description = __expectString(data.Description);
   }
+  if (data.DeviceAggregatedStatus != null) {
+    contents.DeviceAggregatedStatus = __expectString(data.DeviceAggregatedStatus);
+  }
   if (data.DeviceConnectionStatus != null) {
     contents.DeviceConnectionStatus = __expectString(data.DeviceConnectionStatus);
   }
@@ -1684,6 +1692,9 @@ export const deserializeAws_restJson1DescribeDeviceCommand = async (
   if (data.LatestAlternateSoftware != null) {
     contents.LatestAlternateSoftware = __expectString(data.LatestAlternateSoftware);
   }
+  if (data.LatestDeviceJob != null) {
+    contents.LatestDeviceJob = deserializeAws_restJson1LatestDeviceJob(data.LatestDeviceJob, context);
+  }
   if (data.LatestSoftware != null) {
     contents.LatestSoftware = __expectString(data.LatestSoftware);
   }
@@ -3458,17 +3469,26 @@ const deserializeAws_restJson1Device = (output: any, context: __SerdeContext): D
       output.CreatedTime != null
         ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.CreatedTime)))
         : undefined,
+    CurrentSoftware: __expectString(output.CurrentSoftware),
+    Description: __expectString(output.Description),
+    DeviceAggregatedStatus: __expectString(output.DeviceAggregatedStatus),
     DeviceId: __expectString(output.DeviceId),
     LastUpdatedTime:
       output.LastUpdatedTime != null
         ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.LastUpdatedTime)))
         : undefined,
+    LatestDeviceJob:
+      output.LatestDeviceJob != null
+        ? deserializeAws_restJson1LatestDeviceJob(output.LatestDeviceJob, context)
+        : undefined,
     LeaseExpirationTime:
       output.LeaseExpirationTime != null
         ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.LeaseExpirationTime)))
         : undefined,
     Name: __expectString(output.Name),
     ProvisioningStatus: __expectString(output.ProvisioningStatus),
+    Tags: output.Tags != null ? deserializeAws_restJson1TagMap(output.Tags, context) : undefined,
+    Type: __expectString(output.Type),
   } as any;
 };
 
@@ -3588,6 +3608,13 @@ const deserializeAws_restJson1JobTagsList = (output: any, context: __SerdeContex
   return retVal;
 };
 
+const deserializeAws_restJson1LatestDeviceJob = (output: any, context: __SerdeContext): LatestDeviceJob => {
+  return {
+    ImageVersion: __expectString(output.ImageVersion),
+    Status: __expectString(output.Status),
+  } as any;
+};
+
 const deserializeAws_restJson1ManifestOverridesPayload = (
   output: any,
   context: __SerdeContext