aws-sdk-iot 1.140.0 → 1.141.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18ed550997651dc40a4b02646548042373efe25728d0dd6740d9ddcfdfab9865
-  data.tar.gz: 85b773dfc422142b20c81835bdfbb277f67ca16e7dd44bf74cee177624bceca1
+  metadata.gz: 5ff823b18af39585071ae9c4927ae848970348d59621ca6baee7087fecc345fd
+  data.tar.gz: 27d39b408ebb1127619ed0488087915eea1637e071de24b4df923e186038ce48
 SHA512:
-  metadata.gz: 12e6cdc2862247a8a4aa4b803ed408a561c77d645c6eafb34e2bda8dd48e36d281dc6c1c47e6ddd7654220c113ae068be840635b49bb09761396224334bbe1da
-  data.tar.gz: e4b3f472a45de41d0658b292363ba8b12a52ad9f3f1bcf5fcc7a718153fa3fbb40cfea565a81f422c3a45c491d2b2ac0da78efcd0d42eaf4dd4fdf19ef8eaa3f
+  metadata.gz: 130dcccb9ee1b603e042c2c95a954a8382d69ba0a89225af206f74cecb818890abec7fc4a0c2cbba4b03267eace65d69a6053abd101fdebdc68ff4776385a51b
+  data.tar.gz: a44ad986149c657949e9cbc34e0d86088e2e4cccc9079351c020b38e0e5b8e7365ec35cb4bfbd975cb927b5483759d9dd3abc1f1b6357c3da0087af135b69b1a

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.141.0 (2024-12-18)
+------------------
+
+* Feature - Release connectivity status query API which is a dedicated high throughput(TPS) API to query a specific device's most recent connectivity state and metadata.
+
 1.140.0 (2024-11-21)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.140.0
+1.141.0

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

@@ -1575,7 +1575,11 @@ module Aws::IoT
     #   when running the command using the `StartCommandExecution` API.
     #
     # @option params [String] :role_arn
-    #   The IAM role that allows access to create the command.
+    #   The IAM role that you must provide when using the `AWS-IoT-FleetWise`
+    #   namespace. The role grants IoT Device Management the permission to
+    #   access IoT FleetWise resources for generating the payload for the
+    #   command. This field is not required when you use the `AWS-IoT`
+    #   namespace.
     #
     # @option params [Array<Types::Tag>] :tags
     #   Name-value pairs that are used as metadata to manage a command.
@@ -8491,6 +8495,38 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # Retrieves the live connectivity status per device.
+    #
+    # @option params [required, String] :thing_name
+    #   The name of your IoT thing.
+    #
+    # @return [Types::GetThingConnectivityDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetThingConnectivityDataResponse#thing_name #thing_name} => String
+    #   * {Types::GetThingConnectivityDataResponse#connected #connected} => Boolean
+    #   * {Types::GetThingConnectivityDataResponse#timestamp #timestamp} => Time
+    #   * {Types::GetThingConnectivityDataResponse#disconnect_reason #disconnect_reason} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_thing_connectivity_data({
+    #     thing_name: "ConnectivityApiThingName", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.thing_name #=> String
+    #   resp.connected #=> Boolean
+    #   resp.timestamp #=> Time
+    #   resp.disconnect_reason #=> String, one of "AUTH_ERROR", "CLIENT_INITIATED_DISCONNECT", "CLIENT_ERROR", "CONNECTION_LOST", "DUPLICATE_CLIENTID", "FORBIDDEN_ACCESS", "MQTT_KEEP_ALIVE_TIMEOUT", "SERVER_ERROR", "SERVER_INITIATED_DISCONNECT", "THROTTLED", "WEBSOCKET_TTL_EXPIRATION", "CUSTOMAUTH_TTL_EXPIRATION", "UNKNOWN", "NONE"
+    #
+    # @overload get_thing_connectivity_data(params = {})
+    # @param [Hash] params ({})
+    def get_thing_connectivity_data(params = {}, options = {})
+      req = build_request(:get_thing_connectivity_data, params)
+      req.send_request(options)
+    end
+
     # Gets information about the rule.
     #
     # Requires permission to access the [GetTopicRule][1] action.
@@ -9742,10 +9778,22 @@ module Aws::IoT
 
     # List all command executions.
     #
-    # You must provide only the `startedTimeFilter` or the
-    # `completedTimeFilter` information. If you provide both time filters,
-    # the API will generate an error. You can use this information to find
-    # command executions that started within a specific timeframe.
+    # * You must provide only the `startedTimeFilter` or the
+    #   `completedTimeFilter` information. If you provide both time filters,
+    #   the API will generate an error. You can use this information to
+    #   retrieve a list of command executions within a specific timeframe.
+    #
+    # * You must provide only the `commandArn` or the `thingArn` information
+    #   depending on whether you want to list executions for a specific
+    #   command or an IoT thing. If you provide both fields, the API will
+    #   generate an error.
+    #
+    #  For more information about considerations for using this API, see
+    # [List command executions in your account (CLI)][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-remote-command-execution-start-monitor.html#iot-remote-command-execution-list-cli
     #
     # @option params [Integer] :max_results
     #   The maximum number of results to return in this operation.
@@ -16336,7 +16384,7 @@ module Aws::IoT
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-iot'
-      context[:gem_version] = '1.140.0'
+      context[:gem_version] = '1.141.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -273,6 +273,7 @@ module Aws::IoT
     ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
     ConflictingResourceUpdateException = Shapes::StructureShape.new(name: 'ConflictingResourceUpdateException')
     ConnectionAttributeName = Shapes::StringShape.new(name: 'ConnectionAttributeName')
+    ConnectivityApiThingName = Shapes::StringShape.new(name: 'ConnectivityApiThingName')
     ConnectivityTimestamp = Shapes::IntegerShape.new(name: 'ConnectivityTimestamp')
     ConsecutiveDatapointsToAlarm = Shapes::IntegerShape.new(name: 'ConsecutiveDatapointsToAlarm')
     ConsecutiveDatapointsToClear = Shapes::IntegerShape.new(name: 'ConsecutiveDatapointsToClear')
@@ -536,6 +537,7 @@ module Aws::IoT
     DisassociateSbomFromPackageVersionRequest = Shapes::StructureShape.new(name: 'DisassociateSbomFromPackageVersionRequest')
     DisassociateSbomFromPackageVersionResponse = Shapes::StructureShape.new(name: 'DisassociateSbomFromPackageVersionResponse')
     DisconnectReason = Shapes::StringShape.new(name: 'DisconnectReason')
+    DisconnectReasonValue = Shapes::StringShape.new(name: 'DisconnectReasonValue')
     DisplayName = Shapes::StringShape.new(name: 'DisplayName')
     DocumentParameter = Shapes::StructureShape.new(name: 'DocumentParameter')
     DocumentParameters = Shapes::ListShape.new(name: 'DocumentParameters')
@@ -654,6 +656,8 @@ module Aws::IoT
     GetRegistrationCodeResponse = Shapes::StructureShape.new(name: 'GetRegistrationCodeResponse')
     GetStatisticsRequest = Shapes::StructureShape.new(name: 'GetStatisticsRequest')
     GetStatisticsResponse = Shapes::StructureShape.new(name: 'GetStatisticsResponse')
+    GetThingConnectivityDataRequest = Shapes::StructureShape.new(name: 'GetThingConnectivityDataRequest')
+    GetThingConnectivityDataResponse = Shapes::StructureShape.new(name: 'GetThingConnectivityDataResponse')
     GetTopicRuleDestinationRequest = Shapes::StructureShape.new(name: 'GetTopicRuleDestinationRequest')
     GetTopicRuleDestinationResponse = Shapes::StructureShape.new(name: 'GetTopicRuleDestinationResponse')
     GetTopicRuleRequest = Shapes::StructureShape.new(name: 'GetTopicRuleRequest')
@@ -3396,6 +3400,15 @@ module Aws::IoT
     GetStatisticsResponse.add_member(:statistics, Shapes::ShapeRef.new(shape: Statistics, location_name: "statistics"))
     GetStatisticsResponse.struct_class = Types::GetStatisticsResponse
 
+    GetThingConnectivityDataRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ConnectivityApiThingName, required: true, location: "uri", location_name: "thingName"))
+    GetThingConnectivityDataRequest.struct_class = Types::GetThingConnectivityDataRequest
+
+    GetThingConnectivityDataResponse.add_member(:thing_name, Shapes::ShapeRef.new(shape: ConnectivityApiThingName, location_name: "thingName"))
+    GetThingConnectivityDataResponse.add_member(:connected, Shapes::ShapeRef.new(shape: Boolean, location_name: "connected"))
+    GetThingConnectivityDataResponse.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "timestamp"))
+    GetThingConnectivityDataResponse.add_member(:disconnect_reason, Shapes::ShapeRef.new(shape: DisconnectReasonValue, location_name: "disconnectReason"))
+    GetThingConnectivityDataResponse.struct_class = Types::GetThingConnectivityDataResponse
+
     GetTopicRuleDestinationRequest.add_member(:arn, Shapes::ShapeRef.new(shape: AwsArn, required: true, location: "uri", location_name: "arn"))
     GetTopicRuleDestinationRequest.struct_class = Types::GetTopicRuleDestinationRequest
 
@@ -7609,6 +7622,21 @@ module Aws::IoT
         o.errors << Shapes::ShapeRef.new(shape: IndexNotReadyException)
       end)
 
+      api.add_operation(:get_thing_connectivity_data, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetThingConnectivityData"
+        o.http_method = "POST"
+        o.http_request_uri = "/things/{thingName}/connectivity-data"
+        o.input = Shapes::ShapeRef.new(shape: GetThingConnectivityDataRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetThingConnectivityDataResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: IndexNotReadyException)
+      end)
+
       api.add_operation(:get_topic_rule, Seahorse::Model::Operation.new.tap do |o|
         o.name = "GetTopicRule"
         o.http_method = "GET"

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

@@ -2795,7 +2795,11 @@ module Aws::IoT
     #   @return [Array<Types::CommandParameter>]
     #
     # @!attribute [rw] role_arn
-    #   The IAM role that allows access to create the command.
+    #   The IAM role that you must provide when using the
+    #   `AWS-IoT-FleetWise` namespace. The role grants IoT Device Management
+    #   the permission to access IoT FleetWise resources for generating the
+    #   payload for the command. This field is not required when you use the
+    #   `AWS-IoT` namespace.
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -8084,7 +8088,9 @@ module Aws::IoT
     #   @return [Time]
     #
     # @!attribute [rw] time_to_live
-    #   The time to live (TTL) parameter for the `GetCommandExecution` API.
+    #   The time to live (TTL) parameter that indicates the duration for
+    #   which executions will be retained in your account. The default value
+    #   is six months.
     #   @return [Time]
     #
     class GetCommandExecutionResponse < Struct.new(
@@ -8146,8 +8152,8 @@ module Aws::IoT
     #   @return [Types::CommandPayload]
     #
     # @!attribute [rw] role_arn
-    #   The IAM role that allows access to retrieve information about the
-    #   command.
+    #   The IAM role that you provided when creating the command with
+    #   `AWS-IoT-FleetWise` as the namespace.
     #   @return [String]
     #
     # @!attribute [rw] created_at
@@ -8672,6 +8678,41 @@ module Aws::IoT
       include Aws::Structure
     end
 
+    # @!attribute [rw] thing_name
+    #   The name of your IoT thing.
+    #   @return [String]
+    #
+    class GetThingConnectivityDataRequest < Struct.new(
+      :thing_name)
+      SENSITIVE = [:thing_name]
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] thing_name
+    #   The name of your IoT thing.
+    #   @return [String]
+    #
+    # @!attribute [rw] connected
+    #   A Boolean that indicates the connectivity status.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] timestamp
+    #   The timestamp of when the event occurred.
+    #   @return [Time]
+    #
+    # @!attribute [rw] disconnect_reason
+    #   The reason why the client is disconnecting.
+    #   @return [String]
+    #
+    class GetThingConnectivityDataResponse < Struct.new(
+      :thing_name,
+      :connected,
+      :timestamp,
+      :disconnect_reason)
+      SENSITIVE = [:thing_name]
+      include Aws::Structure
+    end
+
     # @!attribute [rw] arn
     #   The ARN of the topic rule destination.
     #   @return [String]

data/lib/aws-sdk-iot.rb

@@ -54,7 +54,7 @@ module Aws::IoT
   autoload :EndpointProvider, 'aws-sdk-iot/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-iot/endpoints'
 
-  GEM_VERSION = '1.140.0'
+  GEM_VERSION = '1.141.0'
 
 end
 

data/sig/client.rbs

@@ -2809,6 +2809,19 @@ module Aws
                           ) -> _GetStatisticsResponseSuccess
                         | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetStatisticsResponseSuccess
 
+      interface _GetThingConnectivityDataResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetThingConnectivityDataResponse]
+        def thing_name: () -> ::String
+        def connected: () -> bool
+        def timestamp: () -> ::Time
+        def disconnect_reason: () -> ("AUTH_ERROR" | "CLIENT_INITIATED_DISCONNECT" | "CLIENT_ERROR" | "CONNECTION_LOST" | "DUPLICATE_CLIENTID" | "FORBIDDEN_ACCESS" | "MQTT_KEEP_ALIVE_TIMEOUT" | "SERVER_ERROR" | "SERVER_INITIATED_DISCONNECT" | "THROTTLED" | "WEBSOCKET_TTL_EXPIRATION" | "CUSTOMAUTH_TTL_EXPIRATION" | "UNKNOWN" | "NONE")
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoT/Client.html#get_thing_connectivity_data-instance_method
+      def get_thing_connectivity_data: (
+                                         thing_name: ::String
+                                       ) -> _GetThingConnectivityDataResponseSuccess
+                                     | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetThingConnectivityDataResponseSuccess
+
       interface _GetTopicRuleResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::GetTopicRuleResponse]
         def rule_arn: () -> ::String

data/sig/types.rbs

@@ -2469,6 +2469,19 @@ module Aws::IoT
       SENSITIVE: []
     end
 
+    class GetThingConnectivityDataRequest
+      attr_accessor thing_name: ::String
+      SENSITIVE: [:thing_name]
+    end
+
+    class GetThingConnectivityDataResponse
+      attr_accessor thing_name: ::String
+      attr_accessor connected: bool
+      attr_accessor timestamp: ::Time
+      attr_accessor disconnect_reason: ("AUTH_ERROR" | "CLIENT_INITIATED_DISCONNECT" | "CLIENT_ERROR" | "CONNECTION_LOST" | "DUPLICATE_CLIENTID" | "FORBIDDEN_ACCESS" | "MQTT_KEEP_ALIVE_TIMEOUT" | "SERVER_ERROR" | "SERVER_INITIATED_DISCONNECT" | "THROTTLED" | "WEBSOCKET_TTL_EXPIRATION" | "CUSTOMAUTH_TTL_EXPIRATION" | "UNKNOWN" | "NONE")
+      SENSITIVE: [:thing_name]
+    end
+
     class GetTopicRuleDestinationRequest
       attr_accessor arn: ::String
       SENSITIVE: []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iot
 version: !ruby/object:Gem::Version
-  version: 1.140.0
+  version: 1.141.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core