aws-sdk-iot 1.139.0 → 1.141.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2207,6 +2207,237 @@ module Aws::IoT
2207
2207
  include Aws::Structure
2208
2208
  end
2209
2209
 
2210
+ # The result value of the command execution. The device can use the
2211
+ # result field to share additional details about the execution such as a
2212
+ # return value of a remote function call.
2213
+ #
2214
+ # <note markdown="1"> This field is not applicable if you use the `AWS-IoT-FleetWise`
2215
+ # namespace.
2216
+ #
2217
+ # </note>
2218
+ #
2219
+ # @!attribute [rw] s
2220
+ # An attribute of type String. For example:
2221
+ #
2222
+ # `"S": "Hello"`
2223
+ # @return [String]
2224
+ #
2225
+ # @!attribute [rw] b
2226
+ # An attribute of type Boolean. For example:
2227
+ #
2228
+ # `"BOOL": true`
2229
+ # @return [Boolean]
2230
+ #
2231
+ # @!attribute [rw] bin
2232
+ # An attribute of type Binary.
2233
+ # @return [String]
2234
+ #
2235
+ class CommandExecutionResult < Struct.new(
2236
+ :s,
2237
+ :b,
2238
+ :bin)
2239
+ SENSITIVE = []
2240
+ include Aws::Structure
2241
+ end
2242
+
2243
+ # Summary information about a particular command execution.
2244
+ #
2245
+ # @!attribute [rw] command_arn
2246
+ # The Amazon Resource Name (ARN) of the command execution.
2247
+ # @return [String]
2248
+ #
2249
+ # @!attribute [rw] execution_id
2250
+ # The unique identifier of the command execution.
2251
+ # @return [String]
2252
+ #
2253
+ # @!attribute [rw] target_arn
2254
+ # The Amazon Resource Name (ARN) of the target device for which the
2255
+ # command is being executed.
2256
+ # @return [String]
2257
+ #
2258
+ # @!attribute [rw] status
2259
+ # The status of the command executions.
2260
+ # @return [String]
2261
+ #
2262
+ # @!attribute [rw] created_at
2263
+ # The date and time at which the command execution was created for the
2264
+ # target device.
2265
+ # @return [Time]
2266
+ #
2267
+ # @!attribute [rw] started_at
2268
+ # The date and time at which the command started executing on the
2269
+ # target device.
2270
+ # @return [Time]
2271
+ #
2272
+ # @!attribute [rw] completed_at
2273
+ # The date and time at which the command completed executing on the
2274
+ # target device.
2275
+ # @return [Time]
2276
+ #
2277
+ class CommandExecutionSummary < Struct.new(
2278
+ :command_arn,
2279
+ :execution_id,
2280
+ :target_arn,
2281
+ :status,
2282
+ :created_at,
2283
+ :started_at,
2284
+ :completed_at)
2285
+ SENSITIVE = []
2286
+ include Aws::Structure
2287
+ end
2288
+
2289
+ # A map of key-value pairs that describe the command.
2290
+ #
2291
+ # @!attribute [rw] name
2292
+ # The name of a specific parameter used in a command and command
2293
+ # execution.
2294
+ # @return [String]
2295
+ #
2296
+ # @!attribute [rw] value
2297
+ # The value used to describe the command. When you assign a value to a
2298
+ # parameter, it will override any default value that you had already
2299
+ # specified.
2300
+ # @return [Types::CommandParameterValue]
2301
+ #
2302
+ # @!attribute [rw] default_value
2303
+ # The default value used to describe the command. This is the value
2304
+ # assumed by the parameter if no other value is assigned to it.
2305
+ # @return [Types::CommandParameterValue]
2306
+ #
2307
+ # @!attribute [rw] description
2308
+ # The description of the command parameter.
2309
+ # @return [String]
2310
+ #
2311
+ class CommandParameter < Struct.new(
2312
+ :name,
2313
+ :value,
2314
+ :default_value,
2315
+ :description)
2316
+ SENSITIVE = []
2317
+ include Aws::Structure
2318
+ end
2319
+
2320
+ # The range of possible values that's used to describe a specific
2321
+ # command parameter.
2322
+ #
2323
+ # <note markdown="1"> The `commandParameterValue` can only have one of the below fields
2324
+ # listed.
2325
+ #
2326
+ # </note>
2327
+ #
2328
+ # @!attribute [rw] s
2329
+ # An attribute of type String. For example:
2330
+ #
2331
+ # `"S": "Hello"`
2332
+ # @return [String]
2333
+ #
2334
+ # @!attribute [rw] b
2335
+ # An attribute of type Boolean. For example:
2336
+ #
2337
+ # `"BOOL": true`
2338
+ # @return [Boolean]
2339
+ #
2340
+ # @!attribute [rw] i
2341
+ # An attribute of type Integer (Thirty-Two Bits).
2342
+ # @return [Integer]
2343
+ #
2344
+ # @!attribute [rw] l
2345
+ # An attribute of type Long.
2346
+ # @return [Integer]
2347
+ #
2348
+ # @!attribute [rw] d
2349
+ # An attribute of type Double (Sixty-Four Bits).
2350
+ # @return [Float]
2351
+ #
2352
+ # @!attribute [rw] bin
2353
+ # An attribute of type Binary. For example:
2354
+ #
2355
+ # `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
2356
+ # @return [String]
2357
+ #
2358
+ # @!attribute [rw] ul
2359
+ # An attribute of type unsigned long.
2360
+ # @return [String]
2361
+ #
2362
+ class CommandParameterValue < Struct.new(
2363
+ :s,
2364
+ :b,
2365
+ :i,
2366
+ :l,
2367
+ :d,
2368
+ :bin,
2369
+ :ul)
2370
+ SENSITIVE = []
2371
+ include Aws::Structure
2372
+ end
2373
+
2374
+ # The command payload object that contains the instructions for the
2375
+ # device to process.
2376
+ #
2377
+ # @!attribute [rw] content
2378
+ # The static payload file for the command.
2379
+ # @return [String]
2380
+ #
2381
+ # @!attribute [rw] content_type
2382
+ # The content type that specifies the format type of the payload file.
2383
+ # This field must use a type/subtype format, such as
2384
+ # `application/json`. For information about various content types, see
2385
+ # [Common MIME types][1].
2386
+ #
2387
+ #
2388
+ #
2389
+ # [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types
2390
+ # @return [String]
2391
+ #
2392
+ class CommandPayload < Struct.new(
2393
+ :content,
2394
+ :content_type)
2395
+ SENSITIVE = []
2396
+ include Aws::Structure
2397
+ end
2398
+
2399
+ # Summary information about a particular command resource.
2400
+ #
2401
+ # @!attribute [rw] command_arn
2402
+ # The Amazon Resource Name (ARN) of the command.
2403
+ # @return [String]
2404
+ #
2405
+ # @!attribute [rw] command_id
2406
+ # The unique identifier of the command.
2407
+ # @return [String]
2408
+ #
2409
+ # @!attribute [rw] display_name
2410
+ # The display name of the command.
2411
+ # @return [String]
2412
+ #
2413
+ # @!attribute [rw] deprecated
2414
+ # Indicates whether the command has been deprecated.
2415
+ # @return [Boolean]
2416
+ #
2417
+ # @!attribute [rw] created_at
2418
+ # The timestamp, when the command was created.
2419
+ # @return [Time]
2420
+ #
2421
+ # @!attribute [rw] last_updated_at
2422
+ # The timestamp, when the command was last updated.
2423
+ # @return [Time]
2424
+ #
2425
+ # @!attribute [rw] pending_deletion
2426
+ # Indicates whether the command is pending deletion.
2427
+ # @return [Boolean]
2428
+ #
2429
+ class CommandSummary < Struct.new(
2430
+ :command_arn,
2431
+ :command_id,
2432
+ :display_name,
2433
+ :deprecated,
2434
+ :created_at,
2435
+ :last_updated_at,
2436
+ :pending_deletion)
2437
+ SENSITIVE = []
2438
+ include Aws::Structure
2439
+ end
2440
+
2210
2441
  # Configuration.
2211
2442
  #
2212
2443
  # @!attribute [rw] enabled
@@ -2232,7 +2463,7 @@ module Aws::IoT
2232
2463
 
2233
2464
  class ConfirmTopicRuleDestinationResponse < Aws::EmptyStructure; end
2234
2465
 
2235
- # A resource with the same name already exists.
2466
+ # The request conflicts with the current state of the resource.
2236
2467
  #
2237
2468
  # @!attribute [rw] message
2238
2469
  # @return [String]
@@ -2522,6 +2753,88 @@ module Aws::IoT
2522
2753
  include Aws::Structure
2523
2754
  end
2524
2755
 
2756
+ # @!attribute [rw] command_id
2757
+ # A unique identifier for the command. We recommend using UUID.
2758
+ # Alpha-numeric characters, hyphens, and underscores are valid for use
2759
+ # here.
2760
+ # @return [String]
2761
+ #
2762
+ # @!attribute [rw] namespace
2763
+ # The namespace of the command. The MQTT reserved topics and
2764
+ # validations will be used for command executions according to the
2765
+ # namespace setting.
2766
+ # @return [String]
2767
+ #
2768
+ # @!attribute [rw] display_name
2769
+ # The user-friendly name in the console for the command. This name
2770
+ # doesn't have to be unique. You can update the user-friendly name
2771
+ # after you define it.
2772
+ # @return [String]
2773
+ #
2774
+ # @!attribute [rw] description
2775
+ # A short text decription of the command.
2776
+ # @return [String]
2777
+ #
2778
+ # @!attribute [rw] payload
2779
+ # The payload object for the command. You must specify this
2780
+ # information when using the `AWS-IoT` namespace.
2781
+ #
2782
+ # You can upload a static payload file from your local storage that
2783
+ # contains the instructions for the device to process. The payload
2784
+ # file can use any format. To make sure that the device correctly
2785
+ # interprets the payload, we recommend you to specify the payload
2786
+ # content type.
2787
+ # @return [Types::CommandPayload]
2788
+ #
2789
+ # @!attribute [rw] mandatory_parameters
2790
+ # A list of parameters that are required by the
2791
+ # `StartCommandExecution` API. These parameters need to be specified
2792
+ # only when using the `AWS-IoT-FleetWise` namespace. You can either
2793
+ # specify them here or when running the command using the
2794
+ # `StartCommandExecution` API.
2795
+ # @return [Array<Types::CommandParameter>]
2796
+ #
2797
+ # @!attribute [rw] role_arn
2798
+ # The IAM role that you must provide when using the
2799
+ # `AWS-IoT-FleetWise` namespace. The role grants IoT Device Management
2800
+ # the permission to access IoT FleetWise resources for generating the
2801
+ # payload for the command. This field is not required when you use the
2802
+ # `AWS-IoT` namespace.
2803
+ # @return [String]
2804
+ #
2805
+ # @!attribute [rw] tags
2806
+ # Name-value pairs that are used as metadata to manage a command.
2807
+ # @return [Array<Types::Tag>]
2808
+ #
2809
+ class CreateCommandRequest < Struct.new(
2810
+ :command_id,
2811
+ :namespace,
2812
+ :display_name,
2813
+ :description,
2814
+ :payload,
2815
+ :mandatory_parameters,
2816
+ :role_arn,
2817
+ :tags)
2818
+ SENSITIVE = []
2819
+ include Aws::Structure
2820
+ end
2821
+
2822
+ # @!attribute [rw] command_id
2823
+ # The unique identifier for the command.
2824
+ # @return [String]
2825
+ #
2826
+ # @!attribute [rw] command_arn
2827
+ # The Amazon Resource Number (ARN) of the command. For example,
2828
+ # `arn:aws:iot:<region>:<accountid>:command/<commandId>`
2829
+ # @return [String]
2830
+ #
2831
+ class CreateCommandResponse < Struct.new(
2832
+ :command_id,
2833
+ :command_arn)
2834
+ SENSITIVE = []
2835
+ include Aws::Structure
2836
+ end
2837
+
2525
2838
  # @!attribute [rw] metric_name
2526
2839
  # The name of the custom metric. This will be used in the metric
2527
2840
  # report submitted from the device/thing. The name can't begin with
@@ -2970,9 +3283,9 @@ module Aws::IoT
2970
3283
  end
2971
3284
 
2972
3285
  # @!attribute [rw] job_id
2973
- # A job identifier which must be unique for your Amazon Web Services
2974
- # account. We recommend using a UUID. Alpha-numeric characters, "-"
2975
- # and "\_" are valid for use here.
3286
+ # A job identifier which must be unique for your account. We recommend
3287
+ # using a UUID. Alpha-numeric characters, "-" and "\_" are valid
3288
+ # for use here.
2976
3289
  # @return [String]
2977
3290
  #
2978
3291
  # @!attribute [rw] targets
@@ -4501,6 +4814,59 @@ module Aws::IoT
4501
4814
  include Aws::Structure
4502
4815
  end
4503
4816
 
4817
+ # @!attribute [rw] execution_id
4818
+ # The unique identifier of the command execution that you want to
4819
+ # delete from your account.
4820
+ # @return [String]
4821
+ #
4822
+ # @!attribute [rw] target_arn
4823
+ # The Amazon Resource Number (ARN) of the target device for which you
4824
+ # want to delete command executions.
4825
+ # @return [String]
4826
+ #
4827
+ class DeleteCommandExecutionRequest < Struct.new(
4828
+ :execution_id,
4829
+ :target_arn)
4830
+ SENSITIVE = []
4831
+ include Aws::Structure
4832
+ end
4833
+
4834
+ class DeleteCommandExecutionResponse < Aws::EmptyStructure; end
4835
+
4836
+ # @!attribute [rw] command_id
4837
+ # The unique identifier of the command to be deleted.
4838
+ # @return [String]
4839
+ #
4840
+ class DeleteCommandRequest < Struct.new(
4841
+ :command_id)
4842
+ SENSITIVE = []
4843
+ include Aws::Structure
4844
+ end
4845
+
4846
+ # @!attribute [rw] status_code
4847
+ # The status code for the command deletion request. The status code is
4848
+ # in the 200 range for a successful request.
4849
+ #
4850
+ # * If the command hasn't been deprecated, or has been deprecated for
4851
+ # a duration that is shorter than the maximum time out duration of
4852
+ # 12 hours, when calling the `DeleteCommand` request, the deletion
4853
+ # will be scheduled and a 202 status code will be returned. While
4854
+ # the command is being deleted, it will be in a `pendingDeletion`
4855
+ # state. Once the time out duration has been reached, the command
4856
+ # will be permanently removed from your account.
4857
+ #
4858
+ # * If the command has been deprecated for a duration that is longer
4859
+ # than the maximum time out duration of 12 hours, when calling the
4860
+ # `DeleteCommand` request, the command will be deleted immediately
4861
+ # and a 204 status code will be returned.
4862
+ # @return [Integer]
4863
+ #
4864
+ class DeleteCommandResponse < Struct.new(
4865
+ :status_code)
4866
+ SENSITIVE = []
4867
+ include Aws::Structure
4868
+ end
4869
+
4504
4870
  # You can't delete the resource because it is attached to one or more
4505
4871
  # resources.
4506
4872
  #
@@ -5963,7 +6329,7 @@ module Aws::IoT
5963
6329
  # @return [String]
5964
6330
  #
5965
6331
  # @!attribute [rw] before_substitution
5966
- # A flag that provides a view of the job document before and after the
6332
+ # Provides a view of the job document before and after the
5967
6333
  # substitution parameters have been resolved with their exact values.
5968
6334
  # @return [Boolean]
5969
6335
  #
@@ -7626,6 +7992,203 @@ module Aws::IoT
7626
7992
  include Aws::Structure
7627
7993
  end
7628
7994
 
7995
+ # @!attribute [rw] execution_id
7996
+ # The unique identifier for the command execution. This information is
7997
+ # returned as a response of the `StartCommandExecution` API request.
7998
+ # @return [String]
7999
+ #
8000
+ # @!attribute [rw] target_arn
8001
+ # The Amazon Resource Number (ARN) of the device on which the command
8002
+ # execution is being performed.
8003
+ # @return [String]
8004
+ #
8005
+ # @!attribute [rw] include_result
8006
+ # Can be used to specify whether to include the result of the command
8007
+ # execution in the `GetCommandExecution` API response. Your device can
8008
+ # use this field to provide additional information about the command
8009
+ # execution. You only need to specify this field when using the
8010
+ # `AWS-IoT` namespace.
8011
+ # @return [Boolean]
8012
+ #
8013
+ class GetCommandExecutionRequest < Struct.new(
8014
+ :execution_id,
8015
+ :target_arn,
8016
+ :include_result)
8017
+ SENSITIVE = []
8018
+ include Aws::Structure
8019
+ end
8020
+
8021
+ # @!attribute [rw] execution_id
8022
+ # The unique identifier of the command execution.
8023
+ # @return [String]
8024
+ #
8025
+ # @!attribute [rw] command_arn
8026
+ # The Amazon Resource Number (ARN) of the command. For example,
8027
+ # ``arn:aws:iot:&lt;region&gt;:&lt;accountid&gt;:command/&lt;commandId&gt;
8028
+ # @return [String]
8029
+ #
8030
+ # @!attribute [rw] target_arn
8031
+ # The Amazon Resource Number (ARN) of the device on which the command
8032
+ # execution is being performed.
8033
+ # @return [String]
8034
+ #
8035
+ # @!attribute [rw] status
8036
+ # The status of the command execution. After your devices receive the
8037
+ # command and start performing the operations specified in the
8038
+ # command, it can use the `UpdateCommandExecution` MQTT API to update
8039
+ # the status information.
8040
+ # @return [String]
8041
+ #
8042
+ # @!attribute [rw] status_reason
8043
+ # Your devices can use this parameter to provide additional context
8044
+ # about the status of a command execution using a reason code and
8045
+ # description.
8046
+ # @return [Types::StatusReason]
8047
+ #
8048
+ # @!attribute [rw] result
8049
+ # The result value for the current state of the command execution. The
8050
+ # status provides information about the progress of the command
8051
+ # execution. The device can use the result field to share additional
8052
+ # details about the execution such as a return value of a remote
8053
+ # function call.
8054
+ #
8055
+ # <note markdown="1"> If you use the `AWS-IoT-FleetWise` namespace, then this field is not
8056
+ # applicable in the API response.
8057
+ #
8058
+ # </note>
8059
+ # @return [Hash<String,Types::CommandExecutionResult>]
8060
+ #
8061
+ # @!attribute [rw] parameters
8062
+ # The list of parameters that the `StartCommandExecution` API used
8063
+ # when performing the command on the device.
8064
+ # @return [Hash<String,Types::CommandParameterValue>]
8065
+ #
8066
+ # @!attribute [rw] execution_timeout_seconds
8067
+ # Specifies the amount of time in seconds that the device can take to
8068
+ # finish a command execution. A timer starts when the command
8069
+ # execution is created. If the command execution status is not set to
8070
+ # another terminal state before the timer expires, it will
8071
+ # automatically update to `TIMED_OUT`.
8072
+ # @return [Integer]
8073
+ #
8074
+ # @!attribute [rw] created_at
8075
+ # The timestamp, when the command execution was created.
8076
+ # @return [Time]
8077
+ #
8078
+ # @!attribute [rw] last_updated_at
8079
+ # The timestamp, when the command execution was last updated.
8080
+ # @return [Time]
8081
+ #
8082
+ # @!attribute [rw] started_at
8083
+ # The timestamp, when the command execution was started.
8084
+ # @return [Time]
8085
+ #
8086
+ # @!attribute [rw] completed_at
8087
+ # The timestamp, when the command execution was completed.
8088
+ # @return [Time]
8089
+ #
8090
+ # @!attribute [rw] time_to_live
8091
+ # The time to live (TTL) parameter that indicates the duration for
8092
+ # which executions will be retained in your account. The default value
8093
+ # is six months.
8094
+ # @return [Time]
8095
+ #
8096
+ class GetCommandExecutionResponse < Struct.new(
8097
+ :execution_id,
8098
+ :command_arn,
8099
+ :target_arn,
8100
+ :status,
8101
+ :status_reason,
8102
+ :result,
8103
+ :parameters,
8104
+ :execution_timeout_seconds,
8105
+ :created_at,
8106
+ :last_updated_at,
8107
+ :started_at,
8108
+ :completed_at,
8109
+ :time_to_live)
8110
+ SENSITIVE = []
8111
+ include Aws::Structure
8112
+ end
8113
+
8114
+ # @!attribute [rw] command_id
8115
+ # The unique identifier of the command for which you want to retrieve
8116
+ # information.
8117
+ # @return [String]
8118
+ #
8119
+ class GetCommandRequest < Struct.new(
8120
+ :command_id)
8121
+ SENSITIVE = []
8122
+ include Aws::Structure
8123
+ end
8124
+
8125
+ # @!attribute [rw] command_id
8126
+ # The unique identifier of the command.
8127
+ # @return [String]
8128
+ #
8129
+ # @!attribute [rw] command_arn
8130
+ # The Amazon Resource Number (ARN) of the command. For example,
8131
+ # `arn:aws:iot:<region>:<accountid>:command/<commandId>`
8132
+ # @return [String]
8133
+ #
8134
+ # @!attribute [rw] namespace
8135
+ # The namespace of the command.
8136
+ # @return [String]
8137
+ #
8138
+ # @!attribute [rw] display_name
8139
+ # The user-friendly name in the console for the command.
8140
+ # @return [String]
8141
+ #
8142
+ # @!attribute [rw] description
8143
+ # A short text description of the command.
8144
+ # @return [String]
8145
+ #
8146
+ # @!attribute [rw] mandatory_parameters
8147
+ # A list of parameters for the command created.
8148
+ # @return [Array<Types::CommandParameter>]
8149
+ #
8150
+ # @!attribute [rw] payload
8151
+ # The payload object that you provided for the command.
8152
+ # @return [Types::CommandPayload]
8153
+ #
8154
+ # @!attribute [rw] role_arn
8155
+ # The IAM role that you provided when creating the command with
8156
+ # `AWS-IoT-FleetWise` as the namespace.
8157
+ # @return [String]
8158
+ #
8159
+ # @!attribute [rw] created_at
8160
+ # The timestamp, when the command was created.
8161
+ # @return [Time]
8162
+ #
8163
+ # @!attribute [rw] last_updated_at
8164
+ # The timestamp, when the command was last updated.
8165
+ # @return [Time]
8166
+ #
8167
+ # @!attribute [rw] deprecated
8168
+ # Indicates whether the command has been deprecated.
8169
+ # @return [Boolean]
8170
+ #
8171
+ # @!attribute [rw] pending_deletion
8172
+ # Indicates whether the command is being deleted.
8173
+ # @return [Boolean]
8174
+ #
8175
+ class GetCommandResponse < Struct.new(
8176
+ :command_id,
8177
+ :command_arn,
8178
+ :namespace,
8179
+ :display_name,
8180
+ :description,
8181
+ :mandatory_parameters,
8182
+ :payload,
8183
+ :role_arn,
8184
+ :created_at,
8185
+ :last_updated_at,
8186
+ :deprecated,
8187
+ :pending_deletion)
8188
+ SENSITIVE = []
8189
+ include Aws::Structure
8190
+ end
8191
+
7629
8192
  # @!attribute [rw] principal
7630
8193
  # The principal. Valid principals are CertificateArn
7631
8194
  # (arn:aws:iot:*region*:*accountId*:cert/*certificateId*),
@@ -7684,7 +8247,7 @@ module Aws::IoT
7684
8247
  # @return [String]
7685
8248
  #
7686
8249
  # @!attribute [rw] before_substitution
7687
- # A flag that provides a view of the job document before and after the
8250
+ # Provides a view of the job document before and after the
7688
8251
  # substitution parameters have been resolved with their exact values.
7689
8252
  # @return [Boolean]
7690
8253
  #
@@ -8115,6 +8678,41 @@ module Aws::IoT
8115
8678
  include Aws::Structure
8116
8679
  end
8117
8680
 
8681
+ # @!attribute [rw] thing_name
8682
+ # The name of your IoT thing.
8683
+ # @return [String]
8684
+ #
8685
+ class GetThingConnectivityDataRequest < Struct.new(
8686
+ :thing_name)
8687
+ SENSITIVE = [:thing_name]
8688
+ include Aws::Structure
8689
+ end
8690
+
8691
+ # @!attribute [rw] thing_name
8692
+ # The name of your IoT thing.
8693
+ # @return [String]
8694
+ #
8695
+ # @!attribute [rw] connected
8696
+ # A Boolean that indicates the connectivity status.
8697
+ # @return [Boolean]
8698
+ #
8699
+ # @!attribute [rw] timestamp
8700
+ # The timestamp of when the event occurred.
8701
+ # @return [Time]
8702
+ #
8703
+ # @!attribute [rw] disconnect_reason
8704
+ # The reason why the client is disconnecting.
8705
+ # @return [String]
8706
+ #
8707
+ class GetThingConnectivityDataResponse < Struct.new(
8708
+ :thing_name,
8709
+ :connected,
8710
+ :timestamp,
8711
+ :disconnect_reason)
8712
+ SENSITIVE = [:thing_name]
8713
+ include Aws::Structure
8714
+ end
8715
+
8118
8716
  # @!attribute [rw] arn
8119
8717
  # The ARN of the topic rule destination.
8120
8718
  # @return [String]
@@ -9959,6 +10557,146 @@ module Aws::IoT
9959
10557
  include Aws::Structure
9960
10558
  end
9961
10559
 
10560
+ # @!attribute [rw] max_results
10561
+ # The maximum number of results to return in this operation.
10562
+ # @return [Integer]
10563
+ #
10564
+ # @!attribute [rw] next_token
10565
+ # To retrieve the next set of results, the `nextToken` value from a
10566
+ # previous response; otherwise `null` to receive the first set of
10567
+ # results.
10568
+ # @return [String]
10569
+ #
10570
+ # @!attribute [rw] namespace
10571
+ # The namespace of the command.
10572
+ # @return [String]
10573
+ #
10574
+ # @!attribute [rw] status
10575
+ # List all command executions for the device that have a particular
10576
+ # status. For example, you can filter the list to display only command
10577
+ # executions that have failed or timed out.
10578
+ # @return [String]
10579
+ #
10580
+ # @!attribute [rw] sort_order
10581
+ # Specify whether to list the command executions that were created in
10582
+ # the ascending or descending order. By default, the API returns all
10583
+ # commands in the descending order based on the start time or
10584
+ # completion time of the executions, that are determined by the
10585
+ # `startTimeFilter` and `completeTimeFilter` parameters.
10586
+ # @return [String]
10587
+ #
10588
+ # @!attribute [rw] started_time_filter
10589
+ # List all command executions that started any time before or after
10590
+ # the date and time that you specify. The date and time uses the
10591
+ # format `yyyy-MM-dd'T'HH:mm`.
10592
+ # @return [Types::TimeFilter]
10593
+ #
10594
+ # @!attribute [rw] completed_time_filter
10595
+ # List all command executions that completed any time before or after
10596
+ # the date and time that you specify. The date and time uses the
10597
+ # format `yyyy-MM-dd'T'HH:mm`.
10598
+ # @return [Types::TimeFilter]
10599
+ #
10600
+ # @!attribute [rw] target_arn
10601
+ # The Amazon Resource Number (ARN) of the target device. You can use
10602
+ # this information to list all command executions for a particular
10603
+ # device.
10604
+ # @return [String]
10605
+ #
10606
+ # @!attribute [rw] command_arn
10607
+ # The Amazon Resource Number (ARN) of the command. You can use this
10608
+ # information to list all command executions for a particular command.
10609
+ # @return [String]
10610
+ #
10611
+ class ListCommandExecutionsRequest < Struct.new(
10612
+ :max_results,
10613
+ :next_token,
10614
+ :namespace,
10615
+ :status,
10616
+ :sort_order,
10617
+ :started_time_filter,
10618
+ :completed_time_filter,
10619
+ :target_arn,
10620
+ :command_arn)
10621
+ SENSITIVE = []
10622
+ include Aws::Structure
10623
+ end
10624
+
10625
+ # @!attribute [rw] command_executions
10626
+ # The list of command executions.
10627
+ # @return [Array<Types::CommandExecutionSummary>]
10628
+ #
10629
+ # @!attribute [rw] next_token
10630
+ # The token to use to get the next set of results, or `null` if there
10631
+ # are no additional results.
10632
+ # @return [String]
10633
+ #
10634
+ class ListCommandExecutionsResponse < Struct.new(
10635
+ :command_executions,
10636
+ :next_token)
10637
+ SENSITIVE = []
10638
+ include Aws::Structure
10639
+ end
10640
+
10641
+ # @!attribute [rw] max_results
10642
+ # The maximum number of results to return in this operation. By
10643
+ # default, the API returns up to a maximum of 25 results. You can
10644
+ # override this default value to return up to a maximum of 100 results
10645
+ # for this operation.
10646
+ # @return [Integer]
10647
+ #
10648
+ # @!attribute [rw] next_token
10649
+ # To retrieve the next set of results, the `nextToken` value from a
10650
+ # previous response; otherwise `null` to receive the first set of
10651
+ # results.
10652
+ # @return [String]
10653
+ #
10654
+ # @!attribute [rw] namespace
10655
+ # The namespace of the command. By default, the API returns all
10656
+ # commands that have been created for both `AWS-IoT` and
10657
+ # `AWS-IoT-FleetWise` namespaces. You can override this default value
10658
+ # if you want to return all commands that have been created only for a
10659
+ # specific namespace.
10660
+ # @return [String]
10661
+ #
10662
+ # @!attribute [rw] command_parameter_name
10663
+ # A filter that can be used to display the list of commands that have
10664
+ # a specific command parameter name.
10665
+ # @return [String]
10666
+ #
10667
+ # @!attribute [rw] sort_order
10668
+ # Specify whether to list the commands that you have created in the
10669
+ # ascending or descending order. By default, the API returns all
10670
+ # commands in the descending order based on the time that they were
10671
+ # created.
10672
+ # @return [String]
10673
+ #
10674
+ class ListCommandsRequest < Struct.new(
10675
+ :max_results,
10676
+ :next_token,
10677
+ :namespace,
10678
+ :command_parameter_name,
10679
+ :sort_order)
10680
+ SENSITIVE = []
10681
+ include Aws::Structure
10682
+ end
10683
+
10684
+ # @!attribute [rw] commands
10685
+ # The list of commands.
10686
+ # @return [Array<Types::CommandSummary>]
10687
+ #
10688
+ # @!attribute [rw] next_token
10689
+ # The token to use to get the next set of results, or `null` if there
10690
+ # are no additional results.
10691
+ # @return [String]
10692
+ #
10693
+ class ListCommandsResponse < Struct.new(
10694
+ :commands,
10695
+ :next_token)
10696
+ SENSITIVE = []
10697
+ include Aws::Structure
10698
+ end
10699
+
9962
10700
  # @!attribute [rw] next_token
9963
10701
  # The token for the next set of results.
9964
10702
  # @return [String]
@@ -14309,13 +15047,18 @@ module Aws::IoT
14309
15047
  # The Amazon Resource Name (ARN) for a Lambda function that acts as a
14310
15048
  # Request for Comments (RFC) 6960-compliant Online Certificate Status
14311
15049
  # Protocol (OCSP) responder, supporting basic OCSP responses. The
14312
- # Lambda function accepts a JSON string that's Base64-encoded.
14313
- # Therefore, you must convert your OCSP response, which is typically
14314
- # in the Distinguished Encoding Rules (DER) format, into a JSON string
14315
- # that's Base64-encoded. The Lambda function's response is also a
14316
- # Base64-encoded JSON string and the response payload must not exceed
14317
- # 8 kilobytes (KiB) in size. The Lambda function must be in the same
14318
- # Amazon Web Services region and account as the domain configuration.
15050
+ # Lambda function accepts a base64-encoding of the OCSP request in the
15051
+ # Distinguished Encoding Rules (DER) format. The Lambda function's
15052
+ # response is also a base64-encoded OCSP response in the DER format.
15053
+ # The response size must not exceed 4 kilobytes (KiB). The Lambda
15054
+ # function must be in the same Amazon Web Services account and region
15055
+ # as the domain configuration. For more information, see [Configuring
15056
+ # server certificate OCSP for private endpoints in Amazon Web Services
15057
+ # IoT Core][1] from the Amazon Web Services IoT Core developer guide.
15058
+ #
15059
+ #
15060
+ #
15061
+ # [1]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-cert-config.html#iot-custom-endpoints-cert-config-ocsp-private-endpoint.html
14319
15062
  # @return [String]
14320
15063
  #
14321
15064
  # @!attribute [rw] ocsp_authorized_responder_arn
@@ -14325,8 +15068,8 @@ module Aws::IoT
14325
15068
  # signature of the received OCSP response. The OCSP responder must
14326
15069
  # sign responses using either this authorized responder certificate or
14327
15070
  # the issuing certificate, depending on whether the ARN is provided or
14328
- # not. The certificate must be in the same Amazon Web Services region
14329
- # and account as the domain configuration.
15071
+ # not. The certificate must be in the same Amazon Web Services account
15072
+ # and region as the domain configuration.
14330
15073
  # @return [String]
14331
15074
  #
14332
15075
  class ServerCertificateConfig < Struct.new(
@@ -14359,7 +15102,7 @@ module Aws::IoT
14359
15102
  include Aws::Structure
14360
15103
  end
14361
15104
 
14362
- # A limit has been exceeded.
15105
+ # Service quota has been exceeded.
14363
15106
  #
14364
15107
  # @!attribute [rw] message
14365
15108
  # @return [String]
@@ -14850,6 +15593,26 @@ module Aws::IoT
14850
15593
  include Aws::Structure
14851
15594
  end
14852
15595
 
15596
+ # Provide additional context about the status of a command execution
15597
+ # using a reason code and description.
15598
+ #
15599
+ # @!attribute [rw] reason_code
15600
+ # A code that provides additional context for the command execution
15601
+ # status.
15602
+ # @return [String]
15603
+ #
15604
+ # @!attribute [rw] reason_description
15605
+ # A literal string for devices to optionally provide additional
15606
+ # information about the reason code for a command execution status.
15607
+ # @return [String]
15608
+ #
15609
+ class StatusReason < Struct.new(
15610
+ :reason_code,
15611
+ :reason_description)
15612
+ SENSITIVE = []
15613
+ include Aws::Structure
15614
+ end
15615
+
14853
15616
  # Starts execution of a Step Functions state machine.
14854
15617
  #
14855
15618
  # @!attribute [rw] execution_name_prefix
@@ -15733,6 +16496,26 @@ module Aws::IoT
15733
16496
  include Aws::Structure
15734
16497
  end
15735
16498
 
16499
+ # A filter that can be used to list command executions for a device that
16500
+ # started or completed before or after a particular date and time.
16501
+ #
16502
+ # @!attribute [rw] after
16503
+ # Filter to display command executions that started or completed only
16504
+ # after a particular date and time.
16505
+ # @return [String]
16506
+ #
16507
+ # @!attribute [rw] before
16508
+ # Filter to display command executions that started or completed only
16509
+ # before a particular date and time.
16510
+ # @return [String]
16511
+ #
16512
+ class TimeFilter < Struct.new(
16513
+ :after,
16514
+ :before)
16515
+ SENSITIVE = []
16516
+ include Aws::Structure
16517
+ end
16518
+
15736
16519
  # Specifies the amount of time each device has to finish its execution
15737
16520
  # of the job. A timer is started when the job execution status is set to
15738
16521
  # `IN_PROGRESS`. If the job execution status is not set to another
@@ -16556,6 +17339,64 @@ module Aws::IoT
16556
17339
  include Aws::Structure
16557
17340
  end
16558
17341
 
17342
+ # @!attribute [rw] command_id
17343
+ # The unique identifier of the command to be updated.
17344
+ # @return [String]
17345
+ #
17346
+ # @!attribute [rw] display_name
17347
+ # The new user-friendly name to use in the console for the command.
17348
+ # @return [String]
17349
+ #
17350
+ # @!attribute [rw] description
17351
+ # A short text description of the command.
17352
+ # @return [String]
17353
+ #
17354
+ # @!attribute [rw] deprecated
17355
+ # A boolean that you can use to specify whether to deprecate a
17356
+ # command.
17357
+ # @return [Boolean]
17358
+ #
17359
+ class UpdateCommandRequest < Struct.new(
17360
+ :command_id,
17361
+ :display_name,
17362
+ :description,
17363
+ :deprecated)
17364
+ SENSITIVE = []
17365
+ include Aws::Structure
17366
+ end
17367
+
17368
+ # @!attribute [rw] command_id
17369
+ # The unique identifier of the command.
17370
+ # @return [String]
17371
+ #
17372
+ # @!attribute [rw] display_name
17373
+ # The updated user-friendly display name in the console for the
17374
+ # command.
17375
+ # @return [String]
17376
+ #
17377
+ # @!attribute [rw] description
17378
+ # The updated text description of the command.
17379
+ # @return [String]
17380
+ #
17381
+ # @!attribute [rw] deprecated
17382
+ # The boolean that indicates whether the command was deprecated.
17383
+ # @return [Boolean]
17384
+ #
17385
+ # @!attribute [rw] last_updated_at
17386
+ # The date and time (epoch timestamp in seconds) when the command was
17387
+ # last updated.
17388
+ # @return [Time]
17389
+ #
17390
+ class UpdateCommandResponse < Struct.new(
17391
+ :command_id,
17392
+ :display_name,
17393
+ :description,
17394
+ :deprecated,
17395
+ :last_updated_at)
17396
+ SENSITIVE = []
17397
+ include Aws::Structure
17398
+ end
17399
+
16559
17400
  # @!attribute [rw] metric_name
16560
17401
  # The name of the custom metric. Cannot be updated.
16561
17402
  # @return [String]