aws-sdk-panorama 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7756cc4ac24fcab4c994bd8a7c8696c611124ce2d3d0c5bb7b23b2672150af05
-  data.tar.gz: 5b9501f8e998a5ee3d302c35e8b06b426fc7d66a8023693ddb8e2bc43ce4a651
+  metadata.gz: '08cdcf6d230b188ab968905f215628a2e694d107fad0e4145dc329e38dd242fb'
+  data.tar.gz: 3c5a7b99d66a22dc3216dc536185cd56aa9679ec13debabd5ea94ee195b11bce
 SHA512:
-  metadata.gz: 164761284f3e4570186b9a0a696f188b54ff1f87f3f57b3c1e8b4bc400041f8e23302b0d944045122b577ef8de733110a0b2447293770d2c9ff48fd3353f3bc2
-  data.tar.gz: 197949e0fe88d1cec40a5575467ee4f2458af6cb9b38d87a43b2d26af0cbaa30e3d93bb645faed0be2cec9fab1a0ad14d4384eabfa2777b44733ea702749b3b1
+  metadata.gz: a9aca649c54ffdfea8e960bf7632c8445057e6d348143ceaff7a221a10228429949dd42e0e22ebd35a9a6f6d9739948ae78a5e7e3be82949961fcfae7c4fe3ad
+  data.tar.gz: 5cb34ec87722d801bdf8f98f60645922ba9e4f5103859b1a322da49f233e0104e8c0189e22fb1aa98742b2381c377039887dd4cfe1351ddf6e97b8a81ca34b70

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.8.0 (2022-08-25)
+------------------
+
+* Feature - Support sorting and filtering in ListDevices API, and add more fields to device listings and single device detail
+
 1.7.0 (2022-04-06)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.7.0
+1.8.0

data/lib/aws-sdk-panorama/client.rb

@@ -833,9 +833,11 @@ module Aws::Panorama
     #   * {Types::DescribeDeviceResponse#current_networking_status #current_networking_status} => Types::NetworkStatus
     #   * {Types::DescribeDeviceResponse#current_software #current_software} => String
     #   * {Types::DescribeDeviceResponse#description #description} => String
+    #   * {Types::DescribeDeviceResponse#device_aggregated_status #device_aggregated_status} => String
     #   * {Types::DescribeDeviceResponse#device_connection_status #device_connection_status} => String
     #   * {Types::DescribeDeviceResponse#device_id #device_id} => String
     #   * {Types::DescribeDeviceResponse#latest_alternate_software #latest_alternate_software} => String
+    #   * {Types::DescribeDeviceResponse#latest_device_job #latest_device_job} => Types::LatestDeviceJob
     #   * {Types::DescribeDeviceResponse#latest_software #latest_software} => String
     #   * {Types::DescribeDeviceResponse#lease_expiration_time #lease_expiration_time} => Time
     #   * {Types::DescribeDeviceResponse#name #name} => String
@@ -870,9 +872,12 @@ module Aws::Panorama
     #   resp.current_networking_status.ntp_status.ntp_server_name #=> String
     #   resp.current_software #=> String
     #   resp.description #=> String
+    #   resp.device_aggregated_status #=> String, one of "ERROR", "AWAITING_PROVISIONING", "PENDING", "FAILED", "DELETING", "ONLINE", "OFFLINE", "LEASE_EXPIRED", "UPDATE_NEEDED"
     #   resp.device_connection_status #=> String, one of "ONLINE", "OFFLINE", "AWAITING_CREDENTIALS", "NOT_AVAILABLE", "ERROR"
     #   resp.device_id #=> String
     #   resp.latest_alternate_software #=> String
+    #   resp.latest_device_job.image_version #=> String
+    #   resp.latest_device_job.status #=> String, one of "PENDING", "IN_PROGRESS", "VERIFYING", "REBOOTING", "DOWNLOADING", "COMPLETED", "FAILED"
     #   resp.latest_software #=> String
     #   resp.lease_expiration_time #=> Time
     #   resp.name #=> String
@@ -1387,13 +1392,27 @@ module Aws::Panorama
 
     # Returns a list of devices.
     #
+    # @option params [String] :device_aggregated_status_filter
+    #   Filter based on a device's status.
+    #
     # @option params [Integer] :max_results
     #   The maximum number of devices to return in one page of results.
     #
+    # @option params [String] :name_filter
+    #   Filter based on device's name. Prefixes supported.
+    #
     # @option params [String] :next_token
     #   Specify the pagination token from a previous request to retrieve the
     #   next page of results.
     #
+    # @option params [String] :sort_by
+    #   The target column to be sorted on. Default column sort is
+    #   CREATED\_TIME.
+    #
+    # @option params [String] :sort_order
+    #   The sorting order for the returned list. SortOrder is DESCENDING by
+    #   default based on CREATED\_TIME. Otherwise, SortOrder is ASCENDING.
+    #
     # @return [Types::ListDevicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListDevicesResponse#devices #devices} => Array<Types::Device>
@@ -1404,8 +1423,12 @@ module Aws::Panorama
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_devices({
+    #     device_aggregated_status_filter: "ERROR", # accepts ERROR, AWAITING_PROVISIONING, PENDING, FAILED, DELETING, ONLINE, OFFLINE, LEASE_EXPIRED, UPDATE_NEEDED
     #     max_results: 1,
+    #     name_filter: "NameFilter",
     #     next_token: "NextToken",
+    #     sort_by: "DEVICE_ID", # accepts DEVICE_ID, CREATED_TIME, NAME, DEVICE_AGGREGATED_STATUS
+    #     sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
     #   })
     #
     # @example Response structure
@@ -1413,11 +1436,19 @@ module Aws::Panorama
     #   resp.devices #=> Array
     #   resp.devices[0].brand #=> String, one of "AWS_PANORAMA", "LENOVO"
     #   resp.devices[0].created_time #=> Time
+    #   resp.devices[0].current_software #=> String
+    #   resp.devices[0].description #=> String
+    #   resp.devices[0].device_aggregated_status #=> String, one of "ERROR", "AWAITING_PROVISIONING", "PENDING", "FAILED", "DELETING", "ONLINE", "OFFLINE", "LEASE_EXPIRED", "UPDATE_NEEDED"
     #   resp.devices[0].device_id #=> String
     #   resp.devices[0].last_updated_time #=> Time
+    #   resp.devices[0].latest_device_job.image_version #=> String
+    #   resp.devices[0].latest_device_job.status #=> String, one of "PENDING", "IN_PROGRESS", "VERIFYING", "REBOOTING", "DOWNLOADING", "COMPLETED", "FAILED"
     #   resp.devices[0].lease_expiration_time #=> Time
     #   resp.devices[0].name #=> String
     #   resp.devices[0].provisioning_status #=> String, one of "AWAITING_PROVISIONING", "PENDING", "SUCCEEDED", "FAILED", "ERROR", "DELETING"
+    #   resp.devices[0].tags #=> Hash
+    #   resp.devices[0].tags["TagKey"] #=> String
+    #   resp.devices[0].type #=> String, one of "PANORAMA_APPLIANCE_DEVELOPER_KIT", "PANORAMA_APPLIANCE"
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListDevices AWS API Documentation
@@ -1938,7 +1969,7 @@ module Aws::Panorama
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-panorama'
-      context[:gem_version] = '1.7.0'
+      context[:gem_version] = '1.8.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-panorama/client_api.rb

@@ -73,6 +73,7 @@ module Aws::Panorama
     DescribePackageVersionResponse = Shapes::StructureShape.new(name: 'DescribePackageVersionResponse')
     Description = Shapes::StringShape.new(name: 'Description')
     Device = Shapes::StructureShape.new(name: 'Device')
+    DeviceAggregatedStatus = Shapes::StringShape.new(name: 'DeviceAggregatedStatus')
     DeviceArn = Shapes::StringShape.new(name: 'DeviceArn')
     DeviceBrand = Shapes::StringShape.new(name: 'DeviceBrand')
     DeviceConnectionStatus = Shapes::StringShape.new(name: 'DeviceConnectionStatus')
@@ -106,6 +107,7 @@ module Aws::Panorama
     JobType = Shapes::StringShape.new(name: 'JobType')
     LastUpdatedTime = Shapes::TimestampShape.new(name: 'LastUpdatedTime')
     LatestAlternateSoftware = Shapes::StringShape.new(name: 'LatestAlternateSoftware')
+    LatestDeviceJob = Shapes::StructureShape.new(name: 'LatestDeviceJob')
     LatestSoftware = Shapes::StringShape.new(name: 'LatestSoftware')
     LeaseExpirationTime = Shapes::TimestampShape.new(name: 'LeaseExpirationTime')
     ListApplicationInstanceDependenciesRequest = Shapes::StructureShape.new(name: 'ListApplicationInstanceDependenciesRequest')
@@ -118,6 +120,7 @@ module Aws::Panorama
     ListDevicesJobsResponse = Shapes::StructureShape.new(name: 'ListDevicesJobsResponse')
     ListDevicesRequest = Shapes::StructureShape.new(name: 'ListDevicesRequest')
     ListDevicesResponse = Shapes::StructureShape.new(name: 'ListDevicesResponse')
+    ListDevicesSortBy = Shapes::StringShape.new(name: 'ListDevicesSortBy')
     ListNodeFromTemplateJobsRequest = Shapes::StructureShape.new(name: 'ListNodeFromTemplateJobsRequest')
     ListNodeFromTemplateJobsResponse = Shapes::StructureShape.new(name: 'ListNodeFromTemplateJobsResponse')
     ListNodesRequest = Shapes::StructureShape.new(name: 'ListNodesRequest')
@@ -136,6 +139,7 @@ module Aws::Panorama
     Mask = Shapes::StringShape.new(name: 'Mask')
     MaxConnections = Shapes::IntegerShape.new(name: 'MaxConnections')
     MaxSize25 = Shapes::IntegerShape.new(name: 'MaxSize25')
+    NameFilter = Shapes::StringShape.new(name: 'NameFilter')
     NetworkConnectionStatus = Shapes::StringShape.new(name: 'NetworkConnectionStatus')
     NetworkPayload = Shapes::StructureShape.new(name: 'NetworkPayload')
     NetworkStatus = Shapes::StructureShape.new(name: 'NetworkStatus')
@@ -206,6 +210,7 @@ module Aws::Panorama
     RuntimeRoleArn = Shapes::StringShape.new(name: 'RuntimeRoleArn')
     S3Location = Shapes::StructureShape.new(name: 'S3Location')
     ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
+    SortOrder = Shapes::StringShape.new(name: 'SortOrder')
     StaticIpConnectionInfo = Shapes::StructureShape.new(name: 'StaticIpConnectionInfo')
     StatusFilter = Shapes::StringShape.new(name: 'StatusFilter')
     StorageLocation = Shapes::StructureShape.new(name: 'StorageLocation')
@@ -400,9 +405,11 @@ module Aws::Panorama
     DescribeDeviceResponse.add_member(:current_networking_status, Shapes::ShapeRef.new(shape: NetworkStatus, location_name: "CurrentNetworkingStatus"))
     DescribeDeviceResponse.add_member(:current_software, Shapes::ShapeRef.new(shape: CurrentSoftware, location_name: "CurrentSoftware"))
     DescribeDeviceResponse.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
+    DescribeDeviceResponse.add_member(:device_aggregated_status, Shapes::ShapeRef.new(shape: DeviceAggregatedStatus, location_name: "DeviceAggregatedStatus"))
     DescribeDeviceResponse.add_member(:device_connection_status, Shapes::ShapeRef.new(shape: DeviceConnectionStatus, location_name: "DeviceConnectionStatus"))
     DescribeDeviceResponse.add_member(:device_id, Shapes::ShapeRef.new(shape: DeviceId, location_name: "DeviceId"))
     DescribeDeviceResponse.add_member(:latest_alternate_software, Shapes::ShapeRef.new(shape: LatestAlternateSoftware, location_name: "LatestAlternateSoftware"))
+    DescribeDeviceResponse.add_member(:latest_device_job, Shapes::ShapeRef.new(shape: LatestDeviceJob, location_name: "LatestDeviceJob"))
     DescribeDeviceResponse.add_member(:latest_software, Shapes::ShapeRef.new(shape: LatestSoftware, location_name: "LatestSoftware"))
     DescribeDeviceResponse.add_member(:lease_expiration_time, Shapes::ShapeRef.new(shape: LeaseExpirationTime, location_name: "LeaseExpirationTime"))
     DescribeDeviceResponse.add_member(:name, Shapes::ShapeRef.new(shape: DeviceName, location_name: "Name"))
@@ -499,11 +506,17 @@ module Aws::Panorama
 
     Device.add_member(:brand, Shapes::ShapeRef.new(shape: DeviceBrand, location_name: "Brand"))
     Device.add_member(:created_time, Shapes::ShapeRef.new(shape: CreatedTime, location_name: "CreatedTime"))
+    Device.add_member(:current_software, Shapes::ShapeRef.new(shape: CurrentSoftware, location_name: "CurrentSoftware"))
+    Device.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
+    Device.add_member(:device_aggregated_status, Shapes::ShapeRef.new(shape: DeviceAggregatedStatus, location_name: "DeviceAggregatedStatus"))
     Device.add_member(:device_id, Shapes::ShapeRef.new(shape: DeviceId, location_name: "DeviceId"))
     Device.add_member(:last_updated_time, Shapes::ShapeRef.new(shape: LastUpdatedTime, location_name: "LastUpdatedTime"))
+    Device.add_member(:latest_device_job, Shapes::ShapeRef.new(shape: LatestDeviceJob, location_name: "LatestDeviceJob"))
     Device.add_member(:lease_expiration_time, Shapes::ShapeRef.new(shape: LeaseExpirationTime, location_name: "LeaseExpirationTime"))
     Device.add_member(:name, Shapes::ShapeRef.new(shape: DeviceName, location_name: "Name"))
     Device.add_member(:provisioning_status, Shapes::ShapeRef.new(shape: DeviceStatus, location_name: "ProvisioningStatus"))
+    Device.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
+    Device.add_member(:type, Shapes::ShapeRef.new(shape: DeviceType, location_name: "Type"))
     Device.struct_class = Types::Device
 
     DeviceIdList.member = Shapes::ShapeRef.new(shape: DeviceId)
@@ -550,6 +563,10 @@ module Aws::Panorama
 
     JobTagsList.member = Shapes::ShapeRef.new(shape: JobResourceTags)
 
+    LatestDeviceJob.add_member(:image_version, Shapes::ShapeRef.new(shape: ImageVersion, location_name: "ImageVersion"))
+    LatestDeviceJob.add_member(:status, Shapes::ShapeRef.new(shape: UpdateProgress, location_name: "Status"))
+    LatestDeviceJob.struct_class = Types::LatestDeviceJob
+
     ListApplicationInstanceDependenciesRequest.add_member(:application_instance_id, Shapes::ShapeRef.new(shape: ApplicationInstanceId, required: true, location: "uri", location_name: "ApplicationInstanceId"))
     ListApplicationInstanceDependenciesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxSize25, location: "querystring", location_name: "maxResults"))
     ListApplicationInstanceDependenciesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
@@ -587,8 +604,12 @@ module Aws::Panorama
     ListDevicesJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
     ListDevicesJobsResponse.struct_class = Types::ListDevicesJobsResponse
 
+    ListDevicesRequest.add_member(:device_aggregated_status_filter, Shapes::ShapeRef.new(shape: DeviceAggregatedStatus, location: "querystring", location_name: "DeviceAggregatedStatusFilter"))
     ListDevicesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxSize25, location: "querystring", location_name: "MaxResults"))
+    ListDevicesRequest.add_member(:name_filter, Shapes::ShapeRef.new(shape: NameFilter, location: "querystring", location_name: "NameFilter"))
     ListDevicesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "NextToken"))
+    ListDevicesRequest.add_member(:sort_by, Shapes::ShapeRef.new(shape: ListDevicesSortBy, location: "querystring", location_name: "SortBy"))
+    ListDevicesRequest.add_member(:sort_order, Shapes::ShapeRef.new(shape: SortOrder, location: "querystring", location_name: "SortOrder"))
     ListDevicesRequest.struct_class = Types::ListDevicesRequest
 
     ListDevicesResponse.add_member(:devices, Shapes::ShapeRef.new(shape: DeviceList, required: true, location_name: "Devices"))

data/lib/aws-sdk-panorama/types.rb

@@ -865,6 +865,11 @@ module Aws::Panorama
     #   The device's description.
     #   @return [String]
     #
+    # @!attribute [rw] device_aggregated_status
+    #   A device's aggregated status. Including the device's connection
+    #   status, provisioning status, and lease status.
+    #   @return [String]
+    #
     # @!attribute [rw] device_connection_status
     #   The device's connection status.
     #   @return [String]
@@ -877,6 +882,11 @@ module Aws::Panorama
     #   The most recent beta software release.
     #   @return [String]
     #
+    # @!attribute [rw] latest_device_job
+    #   A device's latest job. Includes the target image version, and the
+    #   job status.
+    #   @return [Types::LatestDeviceJob]
+    #
     # @!attribute [rw] latest_software
     #   The latest software version available for the device.
     #   @return [String]
@@ -919,9 +929,11 @@ module Aws::Panorama
       :current_networking_status,
       :current_software,
       :description,
+      :device_aggregated_status,
       :device_connection_status,
       :device_id,
       :latest_alternate_software,
+      :latest_device_job,
       :latest_software,
       :lease_expiration_time,
       :name,
@@ -1373,6 +1385,19 @@ module Aws::Panorama
     #   When the device was created.
     #   @return [Time]
     #
+    # @!attribute [rw] current_software
+    #   A device's current software.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   A description for the device.
+    #   @return [String]
+    #
+    # @!attribute [rw] device_aggregated_status
+    #   A device's aggregated status. Including the device's connection
+    #   status, provisioning status, and lease status.
+    #   @return [String]
+    #
     # @!attribute [rw] device_id
     #   The device's ID.
     #   @return [String]
@@ -1381,6 +1406,11 @@ module Aws::Panorama
     #   When the device was updated.
     #   @return [Time]
     #
+    # @!attribute [rw] latest_device_job
+    #   A device's latest job. Includes the target image version, and the
+    #   update job status.
+    #   @return [Types::LatestDeviceJob]
+    #
     # @!attribute [rw] lease_expiration_time
     #   The device's lease expiration time.
     #   @return [Time]
@@ -1393,16 +1423,30 @@ module Aws::Panorama
     #   The device's provisioning status.
     #   @return [String]
     #
+    # @!attribute [rw] tags
+    #   The device's tags.
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] type
+    #   The device's type.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/Device AWS API Documentation
     #
     class Device < Struct.new(
       :brand,
       :created_time,
+      :current_software,
+      :description,
+      :device_aggregated_status,
       :device_id,
       :last_updated_time,
+      :latest_device_job,
       :lease_expiration_time,
       :name,
-      :provisioning_status)
+      :provisioning_status,
+      :tags,
+      :type)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1582,6 +1626,25 @@ module Aws::Panorama
       include Aws::Structure
     end
 
+    # Returns information about the latest device job.
+    #
+    # @!attribute [rw] image_version
+    #   The target version of the device software.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   Status of the latest device job.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/LatestDeviceJob AWS API Documentation
+    #
+    class LatestDeviceJob < Struct.new(
+      :image_version,
+      :status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListApplicationInstanceDependenciesRequest
     #   data as a hash:
     #
@@ -1791,24 +1854,50 @@ module Aws::Panorama
     #   data as a hash:
     #
     #       {
+    #         device_aggregated_status_filter: "ERROR", # accepts ERROR, AWAITING_PROVISIONING, PENDING, FAILED, DELETING, ONLINE, OFFLINE, LEASE_EXPIRED, UPDATE_NEEDED
     #         max_results: 1,
+    #         name_filter: "NameFilter",
     #         next_token: "NextToken",
+    #         sort_by: "DEVICE_ID", # accepts DEVICE_ID, CREATED_TIME, NAME, DEVICE_AGGREGATED_STATUS
+    #         sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
     #       }
     #
+    # @!attribute [rw] device_aggregated_status_filter
+    #   Filter based on a device's status.
+    #   @return [String]
+    #
     # @!attribute [rw] max_results
     #   The maximum number of devices to return in one page of results.
     #   @return [Integer]
     #
+    # @!attribute [rw] name_filter
+    #   Filter based on device's name. Prefixes supported.
+    #   @return [String]
+    #
     # @!attribute [rw] next_token
     #   Specify the pagination token from a previous request to retrieve the
     #   next page of results.
     #   @return [String]
     #
+    # @!attribute [rw] sort_by
+    #   The target column to be sorted on. Default column sort is
+    #   CREATED\_TIME.
+    #   @return [String]
+    #
+    # @!attribute [rw] sort_order
+    #   The sorting order for the returned list. SortOrder is DESCENDING by
+    #   default based on CREATED\_TIME. Otherwise, SortOrder is ASCENDING.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListDevicesRequest AWS API Documentation
     #
     class ListDevicesRequest < Struct.new(
+      :device_aggregated_status_filter,
       :max_results,
-      :next_token)
+      :name_filter,
+      :next_token,
+      :sort_by,
+      :sort_order)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-panorama.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-panorama/customizations'
 # @!group service
 module Aws::Panorama
 
-  GEM_VERSION = '1.7.0'
+  GEM_VERSION = '1.8.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-panorama
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core