aws-sdk-iot 1.72.0 → 1.76.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iot/client.rb +1944 -131
- data/lib/aws-sdk-iot/client_api.rb +266 -0
- data/lib/aws-sdk-iot/types.rb +852 -134
- data/lib/aws-sdk-iot.rb +1 -1
- metadata +5 -5
data/lib/aws-sdk-iot/types.rb
CHANGED
@@ -60,8 +60,8 @@ module Aws::IoT
|
|
60
60
|
# The minimum percentage of job execution failures that must occur to
|
61
61
|
# initiate the job abort.
|
62
62
|
#
|
63
|
-
#
|
64
|
-
# 10.9 and 10.99, but not 10.999).
|
63
|
+
# Amazon Web Services IoT Core supports up to two digits after the
|
64
|
+
# decimal (for example, 10.9 and 10.99, but not 10.999).
|
65
65
|
# @return [Float]
|
66
66
|
#
|
67
67
|
# @!attribute [rw] min_number_of_executed_things
|
@@ -276,6 +276,13 @@ module Aws::IoT
|
|
276
276
|
# "String" => "String",
|
277
277
|
# },
|
278
278
|
# },
|
279
|
+
# open_search: {
|
280
|
+
# role_arn: "AwsArn", # required
|
281
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
282
|
+
# index: "ElasticsearchIndex", # required
|
283
|
+
# type: "ElasticsearchType", # required
|
284
|
+
# id: "ElasticsearchId", # required
|
285
|
+
# },
|
279
286
|
# }
|
280
287
|
#
|
281
288
|
# @!attribute [rw] dynamo_db
|
@@ -329,7 +336,18 @@ module Aws::IoT
|
|
329
336
|
# @return [Types::CloudwatchLogsAction]
|
330
337
|
#
|
331
338
|
# @!attribute [rw] elasticsearch
|
332
|
-
# Write data to an Amazon
|
339
|
+
# Write data to an Amazon OpenSearch Service domain.
|
340
|
+
#
|
341
|
+
# <note markdown="1"> The `Elasticsearch` action can only be used by existing rule
|
342
|
+
# actions. To create a new rule action or to update an existing rule
|
343
|
+
# action, use the `OpenSearch` rule action instead. For more
|
344
|
+
# information, see [OpenSearchAction][1].
|
345
|
+
#
|
346
|
+
# </note>
|
347
|
+
#
|
348
|
+
#
|
349
|
+
#
|
350
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html
|
333
351
|
# @return [Types::ElasticsearchAction]
|
334
352
|
#
|
335
353
|
# @!attribute [rw] salesforce
|
@@ -337,15 +355,15 @@ module Aws::IoT
|
|
337
355
|
# @return [Types::SalesforceAction]
|
338
356
|
#
|
339
357
|
# @!attribute [rw] iot_analytics
|
340
|
-
# Sends message data to an
|
358
|
+
# Sends message data to an IoT Analytics channel.
|
341
359
|
# @return [Types::IotAnalyticsAction]
|
342
360
|
#
|
343
361
|
# @!attribute [rw] iot_events
|
344
|
-
# Sends an input to an
|
362
|
+
# Sends an input to an IoT Events detector.
|
345
363
|
# @return [Types::IotEventsAction]
|
346
364
|
#
|
347
365
|
# @!attribute [rw] iot_site_wise
|
348
|
-
# Sends data from the MQTT message that triggered the rule to
|
366
|
+
# Sends data from the MQTT message that triggered the rule to IoT
|
349
367
|
# SiteWise asset properties.
|
350
368
|
# @return [Types::IotSiteWiseAction]
|
351
369
|
#
|
@@ -372,6 +390,10 @@ module Aws::IoT
|
|
372
390
|
# (Amazon MSK) or self-managed Apache Kafka cluster.
|
373
391
|
# @return [Types::KafkaAction]
|
374
392
|
#
|
393
|
+
# @!attribute [rw] open_search
|
394
|
+
# Write data to an Amazon OpenSearch Service domain.
|
395
|
+
# @return [Types::OpenSearchAction]
|
396
|
+
#
|
375
397
|
class Action < Struct.new(
|
376
398
|
:dynamo_db,
|
377
399
|
:dynamo_d_bv_2,
|
@@ -393,7 +415,8 @@ module Aws::IoT
|
|
393
415
|
:step_functions,
|
394
416
|
:timestream,
|
395
417
|
:http,
|
396
|
-
:kafka
|
418
|
+
:kafka,
|
419
|
+
:open_search)
|
397
420
|
SENSITIVE = []
|
398
421
|
include Aws::Structure
|
399
422
|
end
|
@@ -426,6 +449,14 @@ module Aws::IoT
|
|
426
449
|
# The details of a violation event.
|
427
450
|
# @return [Types::ViolationEventAdditionalInfo]
|
428
451
|
#
|
452
|
+
# @!attribute [rw] verification_state
|
453
|
+
# The verification state of the violation (detect alarm).
|
454
|
+
# @return [String]
|
455
|
+
#
|
456
|
+
# @!attribute [rw] verification_state_description
|
457
|
+
# The description of the verification state of the violation.
|
458
|
+
# @return [String]
|
459
|
+
#
|
429
460
|
# @!attribute [rw] last_violation_time
|
430
461
|
# The time the most recent violation occurred.
|
431
462
|
# @return [Time]
|
@@ -441,6 +472,8 @@ module Aws::IoT
|
|
441
472
|
:behavior,
|
442
473
|
:last_violation_value,
|
443
474
|
:violation_event_additional_info,
|
475
|
+
:verification_state,
|
476
|
+
:verification_state_description,
|
444
477
|
:last_violation_time,
|
445
478
|
:violation_start_time)
|
446
479
|
SENSITIVE = []
|
@@ -561,6 +594,31 @@ module Aws::IoT
|
|
561
594
|
include Aws::Structure
|
562
595
|
end
|
563
596
|
|
597
|
+
# The type of aggregation queries.
|
598
|
+
#
|
599
|
+
# @note When making an API call, you may pass AggregationType
|
600
|
+
# data as a hash:
|
601
|
+
#
|
602
|
+
# {
|
603
|
+
# name: "Statistics", # required, accepts Statistics, Percentiles, Cardinality
|
604
|
+
# values: ["AggregationTypeValue"],
|
605
|
+
# }
|
606
|
+
#
|
607
|
+
# @!attribute [rw] name
|
608
|
+
# The name of the aggregation type.
|
609
|
+
# @return [String]
|
610
|
+
#
|
611
|
+
# @!attribute [rw] values
|
612
|
+
# A list of the values of aggregation types.
|
613
|
+
# @return [Array<String>]
|
614
|
+
#
|
615
|
+
class AggregationType < Struct.new(
|
616
|
+
:name,
|
617
|
+
:values)
|
618
|
+
SENSITIVE = []
|
619
|
+
include Aws::Structure
|
620
|
+
end
|
621
|
+
|
564
622
|
# A structure containing the alert target ARN and the role ARN.
|
565
623
|
#
|
566
624
|
# @note When making an API call, you may pass AlertTarget
|
@@ -735,9 +793,9 @@ module Aws::IoT
|
|
735
793
|
# @!attribute [rw] namespace_id
|
736
794
|
# The namespace used to indicate that a job is a customer-managed job.
|
737
795
|
#
|
738
|
-
# When you specify a value for this parameter,
|
739
|
-
# notifications to MQTT topics that contain the value
|
740
|
-
# format.
|
796
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
797
|
+
# Core sends jobs notifications to MQTT topics that contain the value
|
798
|
+
# in the following format.
|
741
799
|
#
|
742
800
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
743
801
|
#
|
@@ -1396,7 +1454,7 @@ module Aws::IoT
|
|
1396
1454
|
# @return [Time]
|
1397
1455
|
#
|
1398
1456
|
# @!attribute [rw] signing_disabled
|
1399
|
-
# Specifies whether
|
1457
|
+
# Specifies whether IoT validates the token signature in an
|
1400
1458
|
# authorization request.
|
1401
1459
|
# @return [Boolean]
|
1402
1460
|
#
|
@@ -1481,8 +1539,8 @@ module Aws::IoT
|
|
1481
1539
|
# The minimum percentage of job execution failures that must occur to
|
1482
1540
|
# initiate the job abort.
|
1483
1541
|
#
|
1484
|
-
#
|
1485
|
-
# 10.9 and 10.99, but not 10.999).
|
1542
|
+
# Amazon Web Services IoT Core supports up to two digits after the
|
1543
|
+
# decimal (for example, 10.9 and 10.99, but not 10.999).
|
1486
1544
|
# @return [Float]
|
1487
1545
|
#
|
1488
1546
|
# @!attribute [rw] min_number_of_executed_things
|
@@ -1561,8 +1619,8 @@ module Aws::IoT
|
|
1561
1619
|
# @!attribute [rw] rate_increase_criteria
|
1562
1620
|
# The criteria to initiate the increase in rate of rollout for a job.
|
1563
1621
|
#
|
1564
|
-
#
|
1565
|
-
# 1.5, but not 1.55).
|
1622
|
+
# Amazon Web Services IoT Core supports up to one digit after the
|
1623
|
+
# decimal (for example, 1.5, but not 1.55).
|
1566
1624
|
# @return [Types::AwsJobRateIncreaseCriteria]
|
1567
1625
|
#
|
1568
1626
|
class AwsJobExponentialRolloutRate < Struct.new(
|
@@ -1879,6 +1937,47 @@ module Aws::IoT
|
|
1879
1937
|
include Aws::Structure
|
1880
1938
|
end
|
1881
1939
|
|
1940
|
+
# A count of documents that meets a specific aggregation criteria.
|
1941
|
+
#
|
1942
|
+
# @!attribute [rw] key_value
|
1943
|
+
# The value counted for the particular bucket.
|
1944
|
+
# @return [String]
|
1945
|
+
#
|
1946
|
+
# @!attribute [rw] count
|
1947
|
+
# The number of documents that have the value counted for the
|
1948
|
+
# particular bucket.
|
1949
|
+
# @return [Integer]
|
1950
|
+
#
|
1951
|
+
class Bucket < Struct.new(
|
1952
|
+
:key_value,
|
1953
|
+
:count)
|
1954
|
+
SENSITIVE = []
|
1955
|
+
include Aws::Structure
|
1956
|
+
end
|
1957
|
+
|
1958
|
+
# The type of bucketed aggregation performed.
|
1959
|
+
#
|
1960
|
+
# @note When making an API call, you may pass BucketsAggregationType
|
1961
|
+
# data as a hash:
|
1962
|
+
#
|
1963
|
+
# {
|
1964
|
+
# terms_aggregation: {
|
1965
|
+
# max_buckets: 1,
|
1966
|
+
# },
|
1967
|
+
# }
|
1968
|
+
#
|
1969
|
+
# @!attribute [rw] terms_aggregation
|
1970
|
+
# Performs an aggregation that will return a list of buckets. The list
|
1971
|
+
# of buckets is a ranked list of the number of occurrences of an
|
1972
|
+
# aggregation field value.
|
1973
|
+
# @return [Types::TermsAggregation]
|
1974
|
+
#
|
1975
|
+
class BucketsAggregationType < Struct.new(
|
1976
|
+
:terms_aggregation)
|
1977
|
+
SENSITIVE = []
|
1978
|
+
include Aws::Structure
|
1979
|
+
end
|
1980
|
+
|
1882
1981
|
# A CA certificate.
|
1883
1982
|
#
|
1884
1983
|
# @!attribute [rw] certificate_arn
|
@@ -2249,11 +2348,12 @@ module Aws::IoT
|
|
2249
2348
|
# @return [String]
|
2250
2349
|
#
|
2251
2350
|
# @!attribute [rw] owned_by
|
2252
|
-
# The ID of the
|
2351
|
+
# The ID of the Amazon Web Services account that owns the certificate.
|
2253
2352
|
# @return [String]
|
2254
2353
|
#
|
2255
2354
|
# @!attribute [rw] previous_owned_by
|
2256
|
-
# The ID of the
|
2355
|
+
# The ID of the Amazon Web Services account of the previous owner of
|
2356
|
+
# the certificate.
|
2257
2357
|
# @return [String]
|
2258
2358
|
#
|
2259
2359
|
# @!attribute [rw] creation_date
|
@@ -2505,7 +2605,7 @@ module Aws::IoT
|
|
2505
2605
|
# }
|
2506
2606
|
#
|
2507
2607
|
# @!attribute [rw] aws_signer_job_id
|
2508
|
-
# The ID of the AWSSignerJob which was created to sign the file.
|
2608
|
+
# The ID of the `AWSSignerJob` which was created to sign the file.
|
2509
2609
|
# @return [String]
|
2510
2610
|
#
|
2511
2611
|
# @!attribute [rw] start_signing_job_parameter
|
@@ -2682,7 +2782,11 @@ module Aws::IoT
|
|
2682
2782
|
# @return [String]
|
2683
2783
|
#
|
2684
2784
|
# @!attribute [rw] client_request_token
|
2685
|
-
#
|
2785
|
+
# Each audit supression must have a unique client request token. If
|
2786
|
+
# you try to create a new audit suppression with the same token as one
|
2787
|
+
# that already exists, an exception occurs. If you omit this value,
|
2788
|
+
# Amazon Web Services SDKs will automatically generate a unique client
|
2789
|
+
# request.
|
2686
2790
|
#
|
2687
2791
|
# **A suitable default value is auto-generated.** You should normally
|
2688
2792
|
# not need to pass this option.
|
@@ -2759,7 +2863,7 @@ module Aws::IoT
|
|
2759
2863
|
# @return [Array<Types::Tag>]
|
2760
2864
|
#
|
2761
2865
|
# @!attribute [rw] signing_disabled
|
2762
|
-
# Specifies whether
|
2866
|
+
# Specifies whether IoT validates the token signature in an
|
2763
2867
|
# authorization request.
|
2764
2868
|
# @return [Boolean]
|
2765
2869
|
#
|
@@ -2936,8 +3040,9 @@ module Aws::IoT
|
|
2936
3040
|
# @!attribute [rw] client_request_token
|
2937
3041
|
# Each custom metric must have a unique client request token. If you
|
2938
3042
|
# try to create a new custom metric that already exists with a
|
2939
|
-
# different token, an exception occurs. If you omit this value,
|
2940
|
-
# SDKs will automatically generate a unique client
|
3043
|
+
# different token, an exception occurs. If you omit this value, Amazon
|
3044
|
+
# Web Services SDKs will automatically generate a unique client
|
3045
|
+
# request.
|
2941
3046
|
#
|
2942
3047
|
# **A suitable default value is auto-generated.** You should normally
|
2943
3048
|
# not need to pass this option.
|
@@ -3008,8 +3113,9 @@ module Aws::IoT
|
|
3008
3113
|
# @!attribute [rw] client_request_token
|
3009
3114
|
# Each dimension must have a unique client request token. If you try
|
3010
3115
|
# to create a new dimension with the same token as a dimension that
|
3011
|
-
# already exists, an exception occurs. If you omit this value,
|
3012
|
-
# SDKs will automatically generate a unique client
|
3116
|
+
# already exists, an exception occurs. If you omit this value, Amazon
|
3117
|
+
# Web Services SDKs will automatically generate a unique client
|
3118
|
+
# request.
|
3013
3119
|
#
|
3014
3120
|
# **A suitable default value is auto-generated.** You should normally
|
3015
3121
|
# not need to pass this option.
|
@@ -3071,16 +3177,17 @@ module Aws::IoT
|
|
3071
3177
|
# @return [String]
|
3072
3178
|
#
|
3073
3179
|
# @!attribute [rw] server_certificate_arns
|
3074
|
-
# The ARNs of the certificates that
|
3075
|
-
#
|
3076
|
-
#
|
3180
|
+
# The ARNs of the certificates that IoT passes to the device during
|
3181
|
+
# the TLS handshake. Currently you can specify only one certificate
|
3182
|
+
# ARN. This value is not required for Amazon Web Services-managed
|
3183
|
+
# domains.
|
3077
3184
|
# @return [Array<String>]
|
3078
3185
|
#
|
3079
3186
|
# @!attribute [rw] validation_certificate_arn
|
3080
3187
|
# The certificate used to validate the server certificate and prove
|
3081
3188
|
# domain name ownership. This certificate must be signed by a public
|
3082
|
-
# certificate authority. This value is not required for
|
3083
|
-
# domains.
|
3189
|
+
# certificate authority. This value is not required for Amazon Web
|
3190
|
+
# Services-managed domains.
|
3084
3191
|
# @return [String]
|
3085
3192
|
#
|
3086
3193
|
# @!attribute [rw] authorizer_config
|
@@ -3090,7 +3197,8 @@ module Aws::IoT
|
|
3090
3197
|
# @!attribute [rw] service_type
|
3091
3198
|
# The type of service delivered by the endpoint.
|
3092
3199
|
#
|
3093
|
-
# <note markdown="1">
|
3200
|
+
# <note markdown="1"> Amazon Web Services IoT Core currently supports only the `DATA`
|
3201
|
+
# service type.
|
3094
3202
|
#
|
3095
3203
|
# </note>
|
3096
3204
|
# @return [String]
|
@@ -3173,7 +3281,7 @@ module Aws::IoT
|
|
3173
3281
|
# @!attribute [rw] index_name
|
3174
3282
|
# The dynamic thing group index name.
|
3175
3283
|
#
|
3176
|
-
# <note markdown="1"> Currently one index is supported:
|
3284
|
+
# <note markdown="1"> Currently one index is supported: `AWS_Things`.
|
3177
3285
|
#
|
3178
3286
|
# </note>
|
3179
3287
|
# @return [String]
|
@@ -3247,6 +3355,106 @@ module Aws::IoT
|
|
3247
3355
|
include Aws::Structure
|
3248
3356
|
end
|
3249
3357
|
|
3358
|
+
# @note When making an API call, you may pass CreateFleetMetricRequest
|
3359
|
+
# data as a hash:
|
3360
|
+
#
|
3361
|
+
# {
|
3362
|
+
# metric_name: "FleetMetricName", # required
|
3363
|
+
# query_string: "QueryString", # required
|
3364
|
+
# aggregation_type: { # required
|
3365
|
+
# name: "Statistics", # required, accepts Statistics, Percentiles, Cardinality
|
3366
|
+
# values: ["AggregationTypeValue"],
|
3367
|
+
# },
|
3368
|
+
# period: 1, # required
|
3369
|
+
# aggregation_field: "AggregationField", # required
|
3370
|
+
# description: "FleetMetricDescription",
|
3371
|
+
# query_version: "QueryVersion",
|
3372
|
+
# index_name: "IndexName",
|
3373
|
+
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
3374
|
+
# tags: [
|
3375
|
+
# {
|
3376
|
+
# key: "TagKey", # required
|
3377
|
+
# value: "TagValue",
|
3378
|
+
# },
|
3379
|
+
# ],
|
3380
|
+
# }
|
3381
|
+
#
|
3382
|
+
# @!attribute [rw] metric_name
|
3383
|
+
# The name of the fleet metric to create.
|
3384
|
+
# @return [String]
|
3385
|
+
#
|
3386
|
+
# @!attribute [rw] query_string
|
3387
|
+
# The search query string.
|
3388
|
+
# @return [String]
|
3389
|
+
#
|
3390
|
+
# @!attribute [rw] aggregation_type
|
3391
|
+
# The type of the aggregation query.
|
3392
|
+
# @return [Types::AggregationType]
|
3393
|
+
#
|
3394
|
+
# @!attribute [rw] period
|
3395
|
+
# The time in seconds between fleet metric emissions. Range \[60(1
|
3396
|
+
# min), 86400(1 day)\] and must be multiple of 60.
|
3397
|
+
# @return [Integer]
|
3398
|
+
#
|
3399
|
+
# @!attribute [rw] aggregation_field
|
3400
|
+
# The field to aggregate.
|
3401
|
+
# @return [String]
|
3402
|
+
#
|
3403
|
+
# @!attribute [rw] description
|
3404
|
+
# The fleet metric description.
|
3405
|
+
# @return [String]
|
3406
|
+
#
|
3407
|
+
# @!attribute [rw] query_version
|
3408
|
+
# The query version.
|
3409
|
+
# @return [String]
|
3410
|
+
#
|
3411
|
+
# @!attribute [rw] index_name
|
3412
|
+
# The name of the index to search.
|
3413
|
+
# @return [String]
|
3414
|
+
#
|
3415
|
+
# @!attribute [rw] unit
|
3416
|
+
# Used to support unit transformation such as milliseconds to seconds.
|
3417
|
+
# The unit must be supported by [CW metric][1]. Default to null.
|
3418
|
+
#
|
3419
|
+
#
|
3420
|
+
#
|
3421
|
+
# [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
|
3422
|
+
# @return [String]
|
3423
|
+
#
|
3424
|
+
# @!attribute [rw] tags
|
3425
|
+
# Metadata, which can be used to manage the fleet metric.
|
3426
|
+
# @return [Array<Types::Tag>]
|
3427
|
+
#
|
3428
|
+
class CreateFleetMetricRequest < Struct.new(
|
3429
|
+
:metric_name,
|
3430
|
+
:query_string,
|
3431
|
+
:aggregation_type,
|
3432
|
+
:period,
|
3433
|
+
:aggregation_field,
|
3434
|
+
:description,
|
3435
|
+
:query_version,
|
3436
|
+
:index_name,
|
3437
|
+
:unit,
|
3438
|
+
:tags)
|
3439
|
+
SENSITIVE = []
|
3440
|
+
include Aws::Structure
|
3441
|
+
end
|
3442
|
+
|
3443
|
+
# @!attribute [rw] metric_name
|
3444
|
+
# The name of the fleet metric to create.
|
3445
|
+
# @return [String]
|
3446
|
+
#
|
3447
|
+
# @!attribute [rw] metric_arn
|
3448
|
+
# The Amazon Resource Name (ARN) of the new fleet metric.
|
3449
|
+
# @return [String]
|
3450
|
+
#
|
3451
|
+
class CreateFleetMetricResponse < Struct.new(
|
3452
|
+
:metric_name,
|
3453
|
+
:metric_arn)
|
3454
|
+
SENSITIVE = []
|
3455
|
+
include Aws::Structure
|
3456
|
+
end
|
3457
|
+
|
3250
3458
|
# @note When making an API call, you may pass CreateJobRequest
|
3251
3459
|
# data as a hash:
|
3252
3460
|
#
|
@@ -3296,9 +3504,9 @@ module Aws::IoT
|
|
3296
3504
|
# }
|
3297
3505
|
#
|
3298
3506
|
# @!attribute [rw] job_id
|
3299
|
-
# A job identifier which must be unique for your
|
3300
|
-
# recommend using a UUID. Alpha-numeric characters, "-"
|
3301
|
-
# are valid for use here.
|
3507
|
+
# A job identifier which must be unique for your Amazon Web Services
|
3508
|
+
# account. We recommend using a UUID. Alpha-numeric characters, "-"
|
3509
|
+
# and "\_" are valid for use here.
|
3302
3510
|
# @return [String]
|
3303
3511
|
#
|
3304
3512
|
# @!attribute [rw] targets
|
@@ -3367,9 +3575,9 @@ module Aws::IoT
|
|
3367
3575
|
# @!attribute [rw] namespace_id
|
3368
3576
|
# The namespace used to indicate that a job is a customer-managed job.
|
3369
3577
|
#
|
3370
|
-
# When you specify a value for this parameter,
|
3371
|
-
# notifications to MQTT topics that contain the value
|
3372
|
-
# format.
|
3578
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
3579
|
+
# Core sends jobs notifications to MQTT topics that contain the value
|
3580
|
+
# in the following format.
|
3373
3581
|
#
|
3374
3582
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
3375
3583
|
#
|
@@ -3556,6 +3764,13 @@ module Aws::IoT
|
|
3556
3764
|
|
3557
3765
|
# The input for the CreateKeysAndCertificate operation.
|
3558
3766
|
#
|
3767
|
+
# Requires permission to access the [CreateKeysAndCertificateRequest][1]
|
3768
|
+
# action.
|
3769
|
+
#
|
3770
|
+
#
|
3771
|
+
#
|
3772
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3773
|
+
#
|
3559
3774
|
# @note When making an API call, you may pass CreateKeysAndCertificateRequest
|
3560
3775
|
# data as a hash:
|
3561
3776
|
#
|
@@ -3580,8 +3795,8 @@ module Aws::IoT
|
|
3580
3795
|
# @return [String]
|
3581
3796
|
#
|
3582
3797
|
# @!attribute [rw] certificate_id
|
3583
|
-
# The ID of the certificate.
|
3584
|
-
#
|
3798
|
+
# The ID of the certificate. IoT issues a default subject name for the
|
3799
|
+
# certificate (for example, IoT Certificate).
|
3585
3800
|
# @return [String]
|
3586
3801
|
#
|
3587
3802
|
# @!attribute [rw] certificate_pem
|
@@ -3829,8 +4044,9 @@ module Aws::IoT
|
|
3829
4044
|
# @return [Array<Types::OTAUpdateFile>]
|
3830
4045
|
#
|
3831
4046
|
# @!attribute [rw] role_arn
|
3832
|
-
# The IAM role that grants
|
3833
|
-
# jobs and
|
4047
|
+
# The IAM role that grants Amazon Web Services IoT Core access to the
|
4048
|
+
# Amazon S3, IoT jobs and Amazon Web Services Code Signing resources
|
4049
|
+
# to create an OTA update job.
|
3834
4050
|
# @return [String]
|
3835
4051
|
#
|
3836
4052
|
# @!attribute [rw] additional_parameters
|
@@ -3865,7 +4081,7 @@ module Aws::IoT
|
|
3865
4081
|
# @return [String]
|
3866
4082
|
#
|
3867
4083
|
# @!attribute [rw] aws_iot_job_id
|
3868
|
-
# The
|
4084
|
+
# The IoT job ID associated with the OTA update.
|
3869
4085
|
# @return [String]
|
3870
4086
|
#
|
3871
4087
|
# @!attribute [rw] ota_update_arn
|
@@ -3873,7 +4089,7 @@ module Aws::IoT
|
|
3873
4089
|
# @return [String]
|
3874
4090
|
#
|
3875
4091
|
# @!attribute [rw] aws_iot_job_arn
|
3876
|
-
# The
|
4092
|
+
# The IoT job ARN associated with the OTA update.
|
3877
4093
|
# @return [String]
|
3878
4094
|
#
|
3879
4095
|
# @!attribute [rw] ota_update_status
|
@@ -4244,7 +4460,8 @@ module Aws::IoT
|
|
4244
4460
|
# @return [String]
|
4245
4461
|
#
|
4246
4462
|
# @!attribute [rw] credential_duration_seconds
|
4247
|
-
# How long (in seconds) the credentials will be valid.
|
4463
|
+
# How long (in seconds) the credentials will be valid. The default
|
4464
|
+
# value is 3,600 seconds.
|
4248
4465
|
# @return [Integer]
|
4249
4466
|
#
|
4250
4467
|
# @!attribute [rw] tags
|
@@ -4988,6 +5205,13 @@ module Aws::IoT
|
|
4988
5205
|
# "String" => "String",
|
4989
5206
|
# },
|
4990
5207
|
# },
|
5208
|
+
# open_search: {
|
5209
|
+
# role_arn: "AwsArn", # required
|
5210
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
5211
|
+
# index: "ElasticsearchIndex", # required
|
5212
|
+
# type: "ElasticsearchType", # required
|
5213
|
+
# id: "ElasticsearchId", # required
|
5214
|
+
# },
|
4991
5215
|
# },
|
4992
5216
|
# ],
|
4993
5217
|
# rule_disabled: false,
|
@@ -5159,6 +5383,13 @@ module Aws::IoT
|
|
5159
5383
|
# "String" => "String",
|
5160
5384
|
# },
|
5161
5385
|
# },
|
5386
|
+
# open_search: {
|
5387
|
+
# role_arn: "AwsArn", # required
|
5388
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
5389
|
+
# index: "ElasticsearchIndex", # required
|
5390
|
+
# type: "ElasticsearchType", # required
|
5391
|
+
# id: "ElasticsearchId", # required
|
5392
|
+
# },
|
5162
5393
|
# },
|
5163
5394
|
# },
|
5164
5395
|
# tags: "String",
|
@@ -5490,6 +5721,29 @@ module Aws::IoT
|
|
5490
5721
|
|
5491
5722
|
class DeleteDynamicThingGroupResponse < Aws::EmptyStructure; end
|
5492
5723
|
|
5724
|
+
# @note When making an API call, you may pass DeleteFleetMetricRequest
|
5725
|
+
# data as a hash:
|
5726
|
+
#
|
5727
|
+
# {
|
5728
|
+
# metric_name: "FleetMetricName", # required
|
5729
|
+
# expected_version: 1,
|
5730
|
+
# }
|
5731
|
+
#
|
5732
|
+
# @!attribute [rw] metric_name
|
5733
|
+
# The name of the fleet metric to delete.
|
5734
|
+
# @return [String]
|
5735
|
+
#
|
5736
|
+
# @!attribute [rw] expected_version
|
5737
|
+
# The expected version of the fleet metric to delete.
|
5738
|
+
# @return [Integer]
|
5739
|
+
#
|
5740
|
+
class DeleteFleetMetricRequest < Struct.new(
|
5741
|
+
:metric_name,
|
5742
|
+
:expected_version)
|
5743
|
+
SENSITIVE = []
|
5744
|
+
include Aws::Structure
|
5745
|
+
end
|
5746
|
+
|
5493
5747
|
# @note When making an API call, you may pass DeleteJobExecutionRequest
|
5494
5748
|
# data as a hash:
|
5495
5749
|
#
|
@@ -5536,9 +5790,9 @@ module Aws::IoT
|
|
5536
5790
|
# @!attribute [rw] namespace_id
|
5537
5791
|
# The namespace used to indicate that a job is a customer-managed job.
|
5538
5792
|
#
|
5539
|
-
# When you specify a value for this parameter,
|
5540
|
-
# notifications to MQTT topics that contain the value
|
5541
|
-
# format.
|
5793
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
5794
|
+
# Core sends jobs notifications to MQTT topics that contain the value
|
5795
|
+
# in the following format.
|
5542
5796
|
#
|
5543
5797
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
5544
5798
|
#
|
@@ -5593,9 +5847,9 @@ module Aws::IoT
|
|
5593
5847
|
# @!attribute [rw] namespace_id
|
5594
5848
|
# The namespace used to indicate that a job is a customer-managed job.
|
5595
5849
|
#
|
5596
|
-
# When you specify a value for this parameter,
|
5597
|
-
# notifications to MQTT topics that contain the value
|
5598
|
-
# format.
|
5850
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
5851
|
+
# Core sends jobs notifications to MQTT topics that contain the value
|
5852
|
+
# in the following format.
|
5599
5853
|
#
|
5600
5854
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
5601
5855
|
#
|
@@ -5668,7 +5922,7 @@ module Aws::IoT
|
|
5668
5922
|
# @return [Boolean]
|
5669
5923
|
#
|
5670
5924
|
# @!attribute [rw] force_delete_aws_job
|
5671
|
-
# When true, deletes the
|
5925
|
+
# When true, deletes the IoT job created by the OTAUpdate process even
|
5672
5926
|
# if it is "IN\_PROGRESS". Otherwise, if the job is not in a
|
5673
5927
|
# terminal state ("COMPLETED" or "CANCELED") an exception will
|
5674
5928
|
# occur. The default is false.
|
@@ -6064,7 +6318,7 @@ module Aws::IoT
|
|
6064
6318
|
class DescribeAccountAuditConfigurationRequest < Aws::EmptyStructure; end
|
6065
6319
|
|
6066
6320
|
# @!attribute [rw] role_arn
|
6067
|
-
# The ARN of the role that grants permission to
|
6321
|
+
# The ARN of the role that grants permission to IoT to access
|
6068
6322
|
# information about your devices, policies, certificates, and other
|
6069
6323
|
# items as required when performing an audit.
|
6070
6324
|
#
|
@@ -6696,14 +6950,13 @@ module Aws::IoT
|
|
6696
6950
|
# ^
|
6697
6951
|
# ^
|
6698
6952
|
#
|
6699
|
-
# * `iot:CredentialProvider` - Returns an
|
6700
|
-
#
|
6953
|
+
# * `iot:CredentialProvider` - Returns an IoT credentials provider API
|
6954
|
+
# endpoint.
|
6701
6955
|
#
|
6702
6956
|
# ^
|
6703
6957
|
# ^
|
6704
6958
|
#
|
6705
|
-
# * `iot:Jobs` - Returns an
|
6706
|
-
# endpoint.
|
6959
|
+
# * `iot:Jobs` - Returns an IoT device management Jobs API endpoint.
|
6707
6960
|
#
|
6708
6961
|
# ^
|
6709
6962
|
#
|
@@ -6755,6 +7008,99 @@ module Aws::IoT
|
|
6755
7008
|
include Aws::Structure
|
6756
7009
|
end
|
6757
7010
|
|
7011
|
+
# @note When making an API call, you may pass DescribeFleetMetricRequest
|
7012
|
+
# data as a hash:
|
7013
|
+
#
|
7014
|
+
# {
|
7015
|
+
# metric_name: "FleetMetricName", # required
|
7016
|
+
# }
|
7017
|
+
#
|
7018
|
+
# @!attribute [rw] metric_name
|
7019
|
+
# The name of the fleet metric to describe.
|
7020
|
+
# @return [String]
|
7021
|
+
#
|
7022
|
+
class DescribeFleetMetricRequest < Struct.new(
|
7023
|
+
:metric_name)
|
7024
|
+
SENSITIVE = []
|
7025
|
+
include Aws::Structure
|
7026
|
+
end
|
7027
|
+
|
7028
|
+
# @!attribute [rw] metric_name
|
7029
|
+
# The name of the fleet metric to describe.
|
7030
|
+
# @return [String]
|
7031
|
+
#
|
7032
|
+
# @!attribute [rw] query_string
|
7033
|
+
# The search query string.
|
7034
|
+
# @return [String]
|
7035
|
+
#
|
7036
|
+
# @!attribute [rw] aggregation_type
|
7037
|
+
# The type of the aggregation query.
|
7038
|
+
# @return [Types::AggregationType]
|
7039
|
+
#
|
7040
|
+
# @!attribute [rw] period
|
7041
|
+
# The time in seconds between fleet metric emissions. Range \[60(1
|
7042
|
+
# min), 86400(1 day)\] and must be multiple of 60.
|
7043
|
+
# @return [Integer]
|
7044
|
+
#
|
7045
|
+
# @!attribute [rw] aggregation_field
|
7046
|
+
# The field to aggregate.
|
7047
|
+
# @return [String]
|
7048
|
+
#
|
7049
|
+
# @!attribute [rw] description
|
7050
|
+
# The fleet metric description.
|
7051
|
+
# @return [String]
|
7052
|
+
#
|
7053
|
+
# @!attribute [rw] query_version
|
7054
|
+
# The query version.
|
7055
|
+
# @return [String]
|
7056
|
+
#
|
7057
|
+
# @!attribute [rw] index_name
|
7058
|
+
# The name of the index to search.
|
7059
|
+
# @return [String]
|
7060
|
+
#
|
7061
|
+
# @!attribute [rw] creation_date
|
7062
|
+
# The date when the fleet metric is created.
|
7063
|
+
# @return [Time]
|
7064
|
+
#
|
7065
|
+
# @!attribute [rw] last_modified_date
|
7066
|
+
# The date when the fleet metric is last modified.
|
7067
|
+
# @return [Time]
|
7068
|
+
#
|
7069
|
+
# @!attribute [rw] unit
|
7070
|
+
# Used to support unit transformation such as milliseconds to seconds.
|
7071
|
+
# The unit must be supported by [CW metric][1].
|
7072
|
+
#
|
7073
|
+
#
|
7074
|
+
#
|
7075
|
+
# [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
|
7076
|
+
# @return [String]
|
7077
|
+
#
|
7078
|
+
# @!attribute [rw] version
|
7079
|
+
# The version of the fleet metric.
|
7080
|
+
# @return [Integer]
|
7081
|
+
#
|
7082
|
+
# @!attribute [rw] metric_arn
|
7083
|
+
# The ARN of the fleet metric to describe.
|
7084
|
+
# @return [String]
|
7085
|
+
#
|
7086
|
+
class DescribeFleetMetricResponse < Struct.new(
|
7087
|
+
:metric_name,
|
7088
|
+
:query_string,
|
7089
|
+
:aggregation_type,
|
7090
|
+
:period,
|
7091
|
+
:aggregation_field,
|
7092
|
+
:description,
|
7093
|
+
:query_version,
|
7094
|
+
:index_name,
|
7095
|
+
:creation_date,
|
7096
|
+
:last_modified_date,
|
7097
|
+
:unit,
|
7098
|
+
:version,
|
7099
|
+
:metric_arn)
|
7100
|
+
SENSITIVE = []
|
7101
|
+
include Aws::Structure
|
7102
|
+
end
|
7103
|
+
|
6758
7104
|
# @note When making an API call, you may pass DescribeIndexRequest
|
6759
7105
|
# data as a hash:
|
6760
7106
|
#
|
@@ -6997,8 +7343,8 @@ module Aws::IoT
|
|
6997
7343
|
# @return [Types::MitigationActionParams]
|
6998
7344
|
#
|
6999
7345
|
# @!attribute [rw] creation_date
|
7000
|
-
# The date and time when the mitigation action was added to your
|
7001
|
-
#
|
7346
|
+
# The date and time when the mitigation action was added to your
|
7347
|
+
# Amazon Web Services accounts.
|
7002
7348
|
# @return [Time]
|
7003
7349
|
#
|
7004
7350
|
# @!attribute [rw] last_modified_date
|
@@ -7525,9 +7871,8 @@ module Aws::IoT
|
|
7525
7871
|
# thing name and use it as the MQTT client ID for the registry and the
|
7526
7872
|
# Device Shadow service.
|
7527
7873
|
#
|
7528
|
-
# This lets you better organize your
|
7529
|
-
#
|
7530
|
-
# shadows.
|
7874
|
+
# This lets you better organize your IoT fleet without removing the
|
7875
|
+
# flexibility of the underlying device certificate model or shadows.
|
7531
7876
|
# @return [String]
|
7532
7877
|
#
|
7533
7878
|
# @!attribute [rw] thing_name
|
@@ -7951,9 +8296,9 @@ module Aws::IoT
|
|
7951
8296
|
|
7952
8297
|
# The summary of a domain configuration. A domain configuration
|
7953
8298
|
# specifies custom IoT-specific information about a domain. A domain
|
7954
|
-
# configuration can be associated with an
|
7955
|
-
# example, dbc123defghijk.iot.us-west-2.amazonaws.com), a
|
7956
|
-
# managed domain, or a default endpoint.
|
8299
|
+
# configuration can be associated with an Amazon Web Services-managed
|
8300
|
+
# domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a
|
8301
|
+
# customer managed domain, or a default endpoint.
|
7957
8302
|
#
|
7958
8303
|
# * Data
|
7959
8304
|
#
|
@@ -8133,8 +8478,19 @@ module Aws::IoT
|
|
8133
8478
|
include Aws::Structure
|
8134
8479
|
end
|
8135
8480
|
|
8136
|
-
# Describes an action that writes data to an Amazon
|
8137
|
-
#
|
8481
|
+
# Describes an action that writes data to an Amazon OpenSearch Service
|
8482
|
+
# domain.
|
8483
|
+
#
|
8484
|
+
# <note markdown="1"> The `Elasticsearch` action can only be used by existing rule actions.
|
8485
|
+
# To create a new rule action or to update an existing rule action, use
|
8486
|
+
# the `OpenSearch` rule action instead. For more information, see
|
8487
|
+
# [OpenSearchAction][1].
|
8488
|
+
#
|
8489
|
+
# </note>
|
8490
|
+
#
|
8491
|
+
#
|
8492
|
+
#
|
8493
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html
|
8138
8494
|
#
|
8139
8495
|
# @note When making an API call, you may pass ElasticsearchAction
|
8140
8496
|
# data as a hash:
|
@@ -8148,15 +8504,15 @@ module Aws::IoT
|
|
8148
8504
|
# }
|
8149
8505
|
#
|
8150
8506
|
# @!attribute [rw] role_arn
|
8151
|
-
# The IAM role ARN that has access to
|
8507
|
+
# The IAM role ARN that has access to OpenSearch.
|
8152
8508
|
# @return [String]
|
8153
8509
|
#
|
8154
8510
|
# @!attribute [rw] endpoint
|
8155
|
-
# The endpoint of your
|
8511
|
+
# The endpoint of your OpenSearch domain.
|
8156
8512
|
# @return [String]
|
8157
8513
|
#
|
8158
8514
|
# @!attribute [rw] index
|
8159
|
-
# The
|
8515
|
+
# The index where you want to store your data.
|
8160
8516
|
# @return [String]
|
8161
8517
|
#
|
8162
8518
|
# @!attribute [rw] type
|
@@ -8177,8 +8533,8 @@ module Aws::IoT
|
|
8177
8533
|
include Aws::Structure
|
8178
8534
|
end
|
8179
8535
|
|
8180
|
-
# Parameters used when defining a mitigation action that enable
|
8181
|
-
# logging.
|
8536
|
+
# Parameters used when defining a mitigation action that enable Amazon
|
8537
|
+
# Web Services IoT Core logging.
|
8182
8538
|
#
|
8183
8539
|
# @note When making an API call, you may pass EnableIoTLoggingParams
|
8184
8540
|
# data as a hash:
|
@@ -8274,8 +8630,8 @@ module Aws::IoT
|
|
8274
8630
|
# @!attribute [rw] increment_factor
|
8275
8631
|
# The exponential factor to increase the rate of rollout for a job.
|
8276
8632
|
#
|
8277
|
-
#
|
8278
|
-
# 1.5, but not 1.55).
|
8633
|
+
# Amazon Web Services IoT Core supports up to one digit after the
|
8634
|
+
# decimal (for example, 1.5, but not 1.55).
|
8279
8635
|
# @return [Float]
|
8280
8636
|
#
|
8281
8637
|
# @!attribute [rw] rate_increase_criteria
|
@@ -8305,7 +8661,7 @@ module Aws::IoT
|
|
8305
8661
|
# @return [String]
|
8306
8662
|
#
|
8307
8663
|
# @!attribute [rw] type
|
8308
|
-
# The
|
8664
|
+
# The data type of the field.
|
8309
8665
|
# @return [String]
|
8310
8666
|
#
|
8311
8667
|
class Field < Struct.new(
|
@@ -8398,6 +8754,23 @@ module Aws::IoT
|
|
8398
8754
|
include Aws::Structure
|
8399
8755
|
end
|
8400
8756
|
|
8757
|
+
# The name and ARN of a fleet metric.
|
8758
|
+
#
|
8759
|
+
# @!attribute [rw] metric_name
|
8760
|
+
# The fleet metric name.
|
8761
|
+
# @return [String]
|
8762
|
+
#
|
8763
|
+
# @!attribute [rw] metric_arn
|
8764
|
+
# The fleet metric ARN.
|
8765
|
+
# @return [String]
|
8766
|
+
#
|
8767
|
+
class FleetMetricNameAndArn < Struct.new(
|
8768
|
+
:metric_name,
|
8769
|
+
:metric_arn)
|
8770
|
+
SENSITIVE = []
|
8771
|
+
include Aws::Structure
|
8772
|
+
end
|
8773
|
+
|
8401
8774
|
# @note When making an API call, you may pass GetBehaviorModelTrainingSummariesRequest
|
8402
8775
|
# data as a hash:
|
8403
8776
|
#
|
@@ -8445,6 +8818,74 @@ module Aws::IoT
|
|
8445
8818
|
include Aws::Structure
|
8446
8819
|
end
|
8447
8820
|
|
8821
|
+
# @note When making an API call, you may pass GetBucketsAggregationRequest
|
8822
|
+
# data as a hash:
|
8823
|
+
#
|
8824
|
+
# {
|
8825
|
+
# index_name: "IndexName",
|
8826
|
+
# query_string: "QueryString", # required
|
8827
|
+
# aggregation_field: "AggregationField", # required
|
8828
|
+
# query_version: "QueryVersion",
|
8829
|
+
# buckets_aggregation_type: { # required
|
8830
|
+
# terms_aggregation: {
|
8831
|
+
# max_buckets: 1,
|
8832
|
+
# },
|
8833
|
+
# },
|
8834
|
+
# }
|
8835
|
+
#
|
8836
|
+
# @!attribute [rw] index_name
|
8837
|
+
# The name of the index to search.
|
8838
|
+
# @return [String]
|
8839
|
+
#
|
8840
|
+
# @!attribute [rw] query_string
|
8841
|
+
# The search query string.
|
8842
|
+
# @return [String]
|
8843
|
+
#
|
8844
|
+
# @!attribute [rw] aggregation_field
|
8845
|
+
# The aggregation field.
|
8846
|
+
# @return [String]
|
8847
|
+
#
|
8848
|
+
# @!attribute [rw] query_version
|
8849
|
+
# The version of the query.
|
8850
|
+
# @return [String]
|
8851
|
+
#
|
8852
|
+
# @!attribute [rw] buckets_aggregation_type
|
8853
|
+
# The basic control of the response shape and the bucket aggregation
|
8854
|
+
# type to perform.
|
8855
|
+
# @return [Types::BucketsAggregationType]
|
8856
|
+
#
|
8857
|
+
class GetBucketsAggregationRequest < Struct.new(
|
8858
|
+
:index_name,
|
8859
|
+
:query_string,
|
8860
|
+
:aggregation_field,
|
8861
|
+
:query_version,
|
8862
|
+
:buckets_aggregation_type)
|
8863
|
+
SENSITIVE = []
|
8864
|
+
include Aws::Structure
|
8865
|
+
end
|
8866
|
+
|
8867
|
+
# @!attribute [rw] total_count
|
8868
|
+
# The total number of documents that fit the query string criteria and
|
8869
|
+
# contain a value for the Aggregation field targeted in the request.
|
8870
|
+
# @return [Integer]
|
8871
|
+
#
|
8872
|
+
# @!attribute [rw] buckets
|
8873
|
+
# The main part of the response with a list of buckets. Each bucket
|
8874
|
+
# contains a `keyValue` and a `count`.
|
8875
|
+
#
|
8876
|
+
# `keyValue`\: The aggregation field value counted for the particular
|
8877
|
+
# bucket.
|
8878
|
+
#
|
8879
|
+
# `count`\: The number of documents that have that value.
|
8880
|
+
# @return [Array<Types::Bucket>]
|
8881
|
+
#
|
8882
|
+
class GetBucketsAggregationResponse < Struct.new(
|
8883
|
+
:total_count,
|
8884
|
+
:buckets)
|
8885
|
+
SENSITIVE = []
|
8886
|
+
include Aws::Structure
|
8887
|
+
end
|
8888
|
+
|
8448
8889
|
# @note When making an API call, you may pass GetCardinalityRequest
|
8449
8890
|
# data as a hash:
|
8450
8891
|
#
|
@@ -8460,7 +8901,7 @@ module Aws::IoT
|
|
8460
8901
|
# @return [String]
|
8461
8902
|
#
|
8462
8903
|
# @!attribute [rw] query_string
|
8463
|
-
# The search query.
|
8904
|
+
# The search query string.
|
8464
8905
|
# @return [String]
|
8465
8906
|
#
|
8466
8907
|
# @!attribute [rw] aggregation_field
|
@@ -8645,7 +9086,7 @@ module Aws::IoT
|
|
8645
9086
|
# @return [String]
|
8646
9087
|
#
|
8647
9088
|
# @!attribute [rw] query_string
|
8648
|
-
# The query string.
|
9089
|
+
# The search query string.
|
8649
9090
|
# @return [String]
|
8650
9091
|
#
|
8651
9092
|
# @!attribute [rw] aggregation_field
|
@@ -8847,7 +9288,8 @@ module Aws::IoT
|
|
8847
9288
|
#
|
8848
9289
|
# @!attribute [rw] query_string
|
8849
9290
|
# The query used to search. You can specify "*" for the query
|
8850
|
-
# string to get the count of all indexed things in your
|
9291
|
+
# string to get the count of all indexed things in your Amazon Web
|
9292
|
+
# Services account.
|
8851
9293
|
# @return [String]
|
8852
9294
|
#
|
8853
9295
|
# @!attribute [rw] aggregation_field
|
@@ -8946,7 +9388,7 @@ module Aws::IoT
|
|
8946
9388
|
class GetV2LoggingOptionsRequest < Aws::EmptyStructure; end
|
8947
9389
|
|
8948
9390
|
# @!attribute [rw] role_arn
|
8949
|
-
# The IAM role ARN
|
9391
|
+
# The IAM role ARN IoT uses to write to your CloudWatch logs.
|
8950
9392
|
# @return [String]
|
8951
9393
|
#
|
8952
9394
|
# @!attribute [rw] default_log_level
|
@@ -9012,9 +9454,9 @@ module Aws::IoT
|
|
9012
9454
|
# @return [String]
|
9013
9455
|
#
|
9014
9456
|
# @!attribute [rw] confirmation_url
|
9015
|
-
# The URL to which
|
9016
|
-
#
|
9017
|
-
#
|
9457
|
+
# The URL to which IoT sends a confirmation message. The value of the
|
9458
|
+
# confirmation URL must be a prefix of the endpoint URL. If you do not
|
9459
|
+
# specify a confirmation URL IoT uses the endpoint URL as the
|
9018
9460
|
# confirmation URL. If you use substitution templates in the
|
9019
9461
|
# confirmationUrl, you must create and enable topic rule destinations
|
9020
9462
|
# that match each possible value of the substitution template before
|
@@ -9130,8 +9572,8 @@ module Aws::IoT
|
|
9130
9572
|
# }
|
9131
9573
|
#
|
9132
9574
|
# @!attribute [rw] confirmation_url
|
9133
|
-
# The URL
|
9134
|
-
#
|
9575
|
+
# The URL IoT uses to confirm ownership of or access to the topic rule
|
9576
|
+
# destination URL.
|
9135
9577
|
# @return [String]
|
9136
9578
|
#
|
9137
9579
|
class HttpUrlDestinationConfiguration < Struct.new(
|
@@ -9277,7 +9719,7 @@ module Aws::IoT
|
|
9277
9719
|
include Aws::Structure
|
9278
9720
|
end
|
9279
9721
|
|
9280
|
-
# Sends message data to an
|
9722
|
+
# Sends message data to an IoT Analytics channel.
|
9281
9723
|
#
|
9282
9724
|
# @note When making an API call, you may pass IotAnalyticsAction
|
9283
9725
|
# data as a hash:
|
@@ -9305,8 +9747,8 @@ module Aws::IoT
|
|
9305
9747
|
#
|
9306
9748
|
# When `batchMode` is `true` and the rule SQL statement evaluates to
|
9307
9749
|
# an Array, each Array element is delivered as a separate message when
|
9308
|
-
# passed by [ `BatchPutMessage` ][1] to the
|
9309
|
-
#
|
9750
|
+
# passed by [ `BatchPutMessage` ][1] to the IoT Analytics channel. The
|
9751
|
+
# resulting array can't have more than 100 messages.
|
9310
9752
|
#
|
9311
9753
|
#
|
9312
9754
|
#
|
@@ -9328,7 +9770,7 @@ module Aws::IoT
|
|
9328
9770
|
include Aws::Structure
|
9329
9771
|
end
|
9330
9772
|
|
9331
|
-
# Sends an input to an
|
9773
|
+
# Sends an input to an IoT Events detector.
|
9332
9774
|
#
|
9333
9775
|
# @note When making an API call, you may pass IotEventsAction
|
9334
9776
|
# data as a hash:
|
@@ -9341,7 +9783,7 @@ module Aws::IoT
|
|
9341
9783
|
# }
|
9342
9784
|
#
|
9343
9785
|
# @!attribute [rw] input_name
|
9344
|
-
# The name of the
|
9786
|
+
# The name of the IoT Events input.
|
9345
9787
|
# @return [String]
|
9346
9788
|
#
|
9347
9789
|
# @!attribute [rw] message_id
|
@@ -9351,7 +9793,7 @@ module Aws::IoT
|
|
9351
9793
|
# UUID value will be assigned.
|
9352
9794
|
#
|
9353
9795
|
# Assign a value to this property to ensure that only one input
|
9354
|
-
# (message) with a given `messageId` will be processed by an
|
9796
|
+
# (message) with a given `messageId` will be processed by an IoT
|
9355
9797
|
# Events detector.
|
9356
9798
|
# @return [String]
|
9357
9799
|
#
|
@@ -9363,8 +9805,8 @@ module Aws::IoT
|
|
9363
9805
|
#
|
9364
9806
|
# When `batchMode` is `true` and the rule SQL statement evaluates to
|
9365
9807
|
# an Array, each Array element is treated as a separate message when
|
9366
|
-
# it's sent to
|
9367
|
-
#
|
9808
|
+
# it's sent to IoT Events by calling [ `BatchPutMessage` ][1]. The
|
9809
|
+
# resulting array can't have more than 10 messages.
|
9368
9810
|
#
|
9369
9811
|
#
|
9370
9812
|
#
|
@@ -9372,9 +9814,8 @@ module Aws::IoT
|
|
9372
9814
|
# @return [Boolean]
|
9373
9815
|
#
|
9374
9816
|
# @!attribute [rw] role_arn
|
9375
|
-
# The ARN of the role that grants
|
9376
|
-
#
|
9377
|
-
# ("Action":"iotevents:BatchPutMessage").
|
9817
|
+
# The ARN of the role that grants IoT permission to send an input to
|
9818
|
+
# an IoT Events detector. ("Action":"iotevents:BatchPutMessage").
|
9378
9819
|
# @return [String]
|
9379
9820
|
#
|
9380
9821
|
class IotEventsAction < Struct.new(
|
@@ -9387,7 +9828,7 @@ module Aws::IoT
|
|
9387
9828
|
end
|
9388
9829
|
|
9389
9830
|
# Describes an action to send data from an MQTT message that triggered
|
9390
|
-
# the rule to
|
9831
|
+
# the rule to IoT SiteWise asset properties.
|
9391
9832
|
#
|
9392
9833
|
# @note When making an API call, you may pass IotSiteWiseAction
|
9393
9834
|
# data as a hash:
|
@@ -9424,8 +9865,8 @@ module Aws::IoT
|
|
9424
9865
|
# @return [Array<Types::PutAssetPropertyValueEntry>]
|
9425
9866
|
#
|
9426
9867
|
# @!attribute [rw] role_arn
|
9427
|
-
# The ARN of the role that grants
|
9428
|
-
# property value to
|
9868
|
+
# The ARN of the role that grants IoT permission to send an asset
|
9869
|
+
# property value to IoT SiteWise. (`"Action":
|
9429
9870
|
# "iotsitewise:BatchPutAssetPropertyValue"`). The trust policy can
|
9430
9871
|
# restrict access to specific asset hierarchy paths.
|
9431
9872
|
# @return [String]
|
@@ -9524,9 +9965,9 @@ module Aws::IoT
|
|
9524
9965
|
# @!attribute [rw] namespace_id
|
9525
9966
|
# The namespace used to indicate that a job is a customer-managed job.
|
9526
9967
|
#
|
9527
|
-
# When you specify a value for this parameter,
|
9528
|
-
# notifications to MQTT topics that contain the value
|
9529
|
-
# format.
|
9968
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
9969
|
+
# Core sends jobs notifications to MQTT topics that contain the value
|
9970
|
+
# in the following format.
|
9530
9971
|
#
|
9531
9972
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
9532
9973
|
#
|
@@ -10030,6 +10471,7 @@ module Aws::IoT
|
|
10030
10471
|
# security_profile_name: "SecurityProfileName",
|
10031
10472
|
# behavior_criteria_type: "STATIC", # accepts STATIC, STATISTICAL, MACHINE_LEARNING
|
10032
10473
|
# list_suppressed_alerts: false,
|
10474
|
+
# verification_state: "FALSE_POSITIVE", # accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
|
10033
10475
|
# next_token: "NextToken",
|
10034
10476
|
# max_results: 1,
|
10035
10477
|
# }
|
@@ -10051,6 +10493,10 @@ module Aws::IoT
|
|
10051
10493
|
# A list of all suppressed alerts.
|
10052
10494
|
# @return [Boolean]
|
10053
10495
|
#
|
10496
|
+
# @!attribute [rw] verification_state
|
10497
|
+
# The verification state of the violation (detect alarm).
|
10498
|
+
# @return [String]
|
10499
|
+
#
|
10054
10500
|
# @!attribute [rw] next_token
|
10055
10501
|
# The token for the next set of results.
|
10056
10502
|
# @return [String]
|
@@ -10064,6 +10510,7 @@ module Aws::IoT
|
|
10064
10510
|
:security_profile_name,
|
10065
10511
|
:behavior_criteria_type,
|
10066
10512
|
:list_suppressed_alerts,
|
10513
|
+
:verification_state,
|
10067
10514
|
:next_token,
|
10068
10515
|
:max_results)
|
10069
10516
|
SENSITIVE = []
|
@@ -10654,7 +11101,7 @@ module Aws::IoT
|
|
10654
11101
|
# The output from the ListCACertificates operation.
|
10655
11102
|
#
|
10656
11103
|
# @!attribute [rw] certificates
|
10657
|
-
# The CA certificates registered in your
|
11104
|
+
# The CA certificates registered in your Amazon Web Services account.
|
10658
11105
|
# @return [Array<Types::CACertificate>]
|
10659
11106
|
#
|
10660
11107
|
# @!attribute [rw] next_marker
|
@@ -11030,6 +11477,47 @@ module Aws::IoT
|
|
11030
11477
|
include Aws::Structure
|
11031
11478
|
end
|
11032
11479
|
|
11480
|
+
# @note When making an API call, you may pass ListFleetMetricsRequest
|
11481
|
+
# data as a hash:
|
11482
|
+
#
|
11483
|
+
# {
|
11484
|
+
# next_token: "NextToken",
|
11485
|
+
# max_results: 1,
|
11486
|
+
# }
|
11487
|
+
#
|
11488
|
+
# @!attribute [rw] next_token
|
11489
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
11490
|
+
# previous response; otherwise `null` to receive the first set of
|
11491
|
+
# results.
|
11492
|
+
# @return [String]
|
11493
|
+
#
|
11494
|
+
# @!attribute [rw] max_results
|
11495
|
+
# The maximum number of results to return in this operation.
|
11496
|
+
# @return [Integer]
|
11497
|
+
#
|
11498
|
+
class ListFleetMetricsRequest < Struct.new(
|
11499
|
+
:next_token,
|
11500
|
+
:max_results)
|
11501
|
+
SENSITIVE = []
|
11502
|
+
include Aws::Structure
|
11503
|
+
end
|
11504
|
+
|
11505
|
+
# @!attribute [rw] fleet_metrics
|
11506
|
+
# The list of fleet metrics objects.
|
11507
|
+
# @return [Array<Types::FleetMetricNameAndArn>]
|
11508
|
+
#
|
11509
|
+
# @!attribute [rw] next_token
|
11510
|
+
# The token for the next set of results. Will not be returned if the
|
11511
|
+
# operation has returned all results.
|
11512
|
+
# @return [String]
|
11513
|
+
#
|
11514
|
+
class ListFleetMetricsResponse < Struct.new(
|
11515
|
+
:fleet_metrics,
|
11516
|
+
:next_token)
|
11517
|
+
SENSITIVE = []
|
11518
|
+
include Aws::Structure
|
11519
|
+
end
|
11520
|
+
|
11033
11521
|
# @note When making an API call, you may pass ListIndicesRequest
|
11034
11522
|
# data as a hash:
|
11035
11523
|
#
|
@@ -11144,9 +11632,9 @@ module Aws::IoT
|
|
11144
11632
|
# @!attribute [rw] namespace_id
|
11145
11633
|
# The namespace used to indicate that a job is a customer-managed job.
|
11146
11634
|
#
|
11147
|
-
# When you specify a value for this parameter,
|
11148
|
-
# notifications to MQTT topics that contain the value
|
11149
|
-
# format.
|
11635
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
11636
|
+
# Core sends jobs notifications to MQTT topics that contain the value
|
11637
|
+
# in the following format.
|
11150
11638
|
#
|
11151
11639
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
11152
11640
|
#
|
@@ -11276,9 +11764,9 @@ module Aws::IoT
|
|
11276
11764
|
# @!attribute [rw] namespace_id
|
11277
11765
|
# The namespace used to indicate that a job is a customer-managed job.
|
11278
11766
|
#
|
11279
|
-
# When you specify a value for this parameter,
|
11280
|
-
# notifications to MQTT topics that contain the value
|
11281
|
-
# format.
|
11767
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
11768
|
+
# Core sends jobs notifications to MQTT topics that contain the value
|
11769
|
+
# in the following format.
|
11282
11770
|
#
|
11283
11771
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
11284
11772
|
#
|
@@ -12792,6 +13280,7 @@ module Aws::IoT
|
|
12792
13280
|
# security_profile_name: "SecurityProfileName",
|
12793
13281
|
# behavior_criteria_type: "STATIC", # accepts STATIC, STATISTICAL, MACHINE_LEARNING
|
12794
13282
|
# list_suppressed_alerts: false,
|
13283
|
+
# verification_state: "FALSE_POSITIVE", # accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
|
12795
13284
|
# next_token: "NextToken",
|
12796
13285
|
# max_results: 1,
|
12797
13286
|
# }
|
@@ -12822,6 +13311,10 @@ module Aws::IoT
|
|
12822
13311
|
# A list of all suppressed alerts.
|
12823
13312
|
# @return [Boolean]
|
12824
13313
|
#
|
13314
|
+
# @!attribute [rw] verification_state
|
13315
|
+
# The verification state of the violation (detect alarm).
|
13316
|
+
# @return [String]
|
13317
|
+
#
|
12825
13318
|
# @!attribute [rw] next_token
|
12826
13319
|
# The token for the next set of results.
|
12827
13320
|
# @return [String]
|
@@ -12837,6 +13330,7 @@ module Aws::IoT
|
|
12837
13330
|
:security_profile_name,
|
12838
13331
|
:behavior_criteria_type,
|
12839
13332
|
:list_suppressed_alerts,
|
13333
|
+
:verification_state,
|
12840
13334
|
:next_token,
|
12841
13335
|
:max_results)
|
12842
13336
|
SENSITIVE = []
|
@@ -13175,8 +13669,8 @@ module Aws::IoT
|
|
13175
13669
|
# @return [Types::ReplaceDefaultPolicyVersionParams]
|
13176
13670
|
#
|
13177
13671
|
# @!attribute [rw] enable_io_t_logging_params
|
13178
|
-
# Parameters to define a mitigation action that enables
|
13179
|
-
# logging at a specified level of detail.
|
13672
|
+
# Parameters to define a mitigation action that enables Amazon Web
|
13673
|
+
# Services IoT Core logging at a specified level of detail.
|
13180
13674
|
# @return [Types::EnableIoTLoggingParams]
|
13181
13675
|
#
|
13182
13676
|
# @!attribute [rw] publish_finding_to_sns_params
|
@@ -13411,11 +13905,11 @@ module Aws::IoT
|
|
13411
13905
|
# @return [String]
|
13412
13906
|
#
|
13413
13907
|
# @!attribute [rw] aws_iot_job_id
|
13414
|
-
# The
|
13908
|
+
# The IoT job ID associated with the OTA update.
|
13415
13909
|
# @return [String]
|
13416
13910
|
#
|
13417
13911
|
# @!attribute [rw] aws_iot_job_arn
|
13418
|
-
# The
|
13912
|
+
# The IoT job ARN associated with the OTA update.
|
13419
13913
|
# @return [String]
|
13420
13914
|
#
|
13421
13915
|
# @!attribute [rw] error_info
|
@@ -13469,6 +13963,50 @@ module Aws::IoT
|
|
13469
13963
|
include Aws::Structure
|
13470
13964
|
end
|
13471
13965
|
|
13966
|
+
# Describes an action that writes data to an Amazon OpenSearch Service
|
13967
|
+
# domain.
|
13968
|
+
#
|
13969
|
+
# @note When making an API call, you may pass OpenSearchAction
|
13970
|
+
# data as a hash:
|
13971
|
+
#
|
13972
|
+
# {
|
13973
|
+
# role_arn: "AwsArn", # required
|
13974
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
13975
|
+
# index: "ElasticsearchIndex", # required
|
13976
|
+
# type: "ElasticsearchType", # required
|
13977
|
+
# id: "ElasticsearchId", # required
|
13978
|
+
# }
|
13979
|
+
#
|
13980
|
+
# @!attribute [rw] role_arn
|
13981
|
+
# The IAM role ARN that has access to OpenSearch.
|
13982
|
+
# @return [String]
|
13983
|
+
#
|
13984
|
+
# @!attribute [rw] endpoint
|
13985
|
+
# The endpoint of your OpenSearch domain.
|
13986
|
+
# @return [String]
|
13987
|
+
#
|
13988
|
+
# @!attribute [rw] index
|
13989
|
+
# The OpenSearch index where you want to store your data.
|
13990
|
+
# @return [String]
|
13991
|
+
#
|
13992
|
+
# @!attribute [rw] type
|
13993
|
+
# The type of document you are storing.
|
13994
|
+
# @return [String]
|
13995
|
+
#
|
13996
|
+
# @!attribute [rw] id
|
13997
|
+
# The unique identifier for the document you are storing.
|
13998
|
+
# @return [String]
|
13999
|
+
#
|
14000
|
+
class OpenSearchAction < Struct.new(
|
14001
|
+
:role_arn,
|
14002
|
+
:endpoint,
|
14003
|
+
:index,
|
14004
|
+
:type,
|
14005
|
+
:id)
|
14006
|
+
SENSITIVE = []
|
14007
|
+
include Aws::Structure
|
14008
|
+
end
|
14009
|
+
|
13472
14010
|
# A certificate that has been transferred but not yet accepted.
|
13473
14011
|
#
|
13474
14012
|
# @!attribute [rw] certificate_arn
|
@@ -13480,7 +14018,7 @@ module Aws::IoT
|
|
13480
14018
|
# @return [String]
|
13481
14019
|
#
|
13482
14020
|
# @!attribute [rw] transferred_to
|
13483
|
-
# The
|
14021
|
+
# The Amazon Web Services account to which the transfer was made.
|
13484
14022
|
# @return [String]
|
13485
14023
|
#
|
13486
14024
|
# @!attribute [rw] transfer_date
|
@@ -13523,7 +14061,7 @@ module Aws::IoT
|
|
13523
14061
|
include Aws::Structure
|
13524
14062
|
end
|
13525
14063
|
|
13526
|
-
# Describes an
|
14064
|
+
# Describes an IoT policy.
|
13527
14065
|
#
|
13528
14066
|
# @!attribute [rw] policy_name
|
13529
14067
|
# The policy name.
|
@@ -13762,7 +14300,7 @@ module Aws::IoT
|
|
13762
14300
|
# @return [String]
|
13763
14301
|
#
|
13764
14302
|
# @!attribute [rw] asset_id
|
13765
|
-
# The ID of the
|
14303
|
+
# The ID of the IoT SiteWise asset. You must specify either a
|
13766
14304
|
# `propertyAlias` or both an `aliasId` and a `propertyId`. Accepts
|
13767
14305
|
# substitution templates.
|
13768
14306
|
# @return [String]
|
@@ -13814,6 +14352,38 @@ module Aws::IoT
|
|
13814
14352
|
include Aws::Structure
|
13815
14353
|
end
|
13816
14354
|
|
14355
|
+
# @note When making an API call, you may pass PutVerificationStateOnViolationRequest
|
14356
|
+
# data as a hash:
|
14357
|
+
#
|
14358
|
+
# {
|
14359
|
+
# violation_id: "ViolationId", # required
|
14360
|
+
# verification_state: "FALSE_POSITIVE", # required, accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
|
14361
|
+
# verification_state_description: "VerificationStateDescription",
|
14362
|
+
# }
|
14363
|
+
#
|
14364
|
+
# @!attribute [rw] violation_id
|
14365
|
+
# The violation ID.
|
14366
|
+
# @return [String]
|
14367
|
+
#
|
14368
|
+
# @!attribute [rw] verification_state
|
14369
|
+
# The verification state of the violation.
|
14370
|
+
# @return [String]
|
14371
|
+
#
|
14372
|
+
# @!attribute [rw] verification_state_description
|
14373
|
+
# The description of the verification state of the violation (detect
|
14374
|
+
# alarm).
|
14375
|
+
# @return [String]
|
14376
|
+
#
|
14377
|
+
class PutVerificationStateOnViolationRequest < Struct.new(
|
14378
|
+
:violation_id,
|
14379
|
+
:verification_state,
|
14380
|
+
:verification_state_description)
|
14381
|
+
SENSITIVE = []
|
14382
|
+
include Aws::Structure
|
14383
|
+
end
|
14384
|
+
|
14385
|
+
class PutVerificationStateOnViolationResponse < Aws::EmptyStructure; end
|
14386
|
+
|
13817
14387
|
# Allows you to define a criteria to initiate the increase in rate of
|
13818
14388
|
# rollout for a job.
|
13819
14389
|
#
|
@@ -14431,6 +15001,13 @@ module Aws::IoT
|
|
14431
15001
|
# "String" => "String",
|
14432
15002
|
# },
|
14433
15003
|
# },
|
15004
|
+
# open_search: {
|
15005
|
+
# role_arn: "AwsArn", # required
|
15006
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
15007
|
+
# index: "ElasticsearchIndex", # required
|
15008
|
+
# type: "ElasticsearchType", # required
|
15009
|
+
# id: "ElasticsearchId", # required
|
15010
|
+
# },
|
14434
15011
|
# },
|
14435
15012
|
# ],
|
14436
15013
|
# rule_disabled: false,
|
@@ -14602,6 +15179,13 @@ module Aws::IoT
|
|
14602
15179
|
# "String" => "String",
|
14603
15180
|
# },
|
14604
15181
|
# },
|
15182
|
+
# open_search: {
|
15183
|
+
# role_arn: "AwsArn", # required
|
15184
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
15185
|
+
# index: "ElasticsearchIndex", # required
|
15186
|
+
# type: "ElasticsearchType", # required
|
15187
|
+
# id: "ElasticsearchId", # required
|
15188
|
+
# },
|
14605
15189
|
# },
|
14606
15190
|
# },
|
14607
15191
|
# }
|
@@ -15436,7 +16020,7 @@ module Aws::IoT
|
|
15436
16020
|
#
|
15437
16021
|
# @!attribute [rw] audit_check_to_actions_mapping
|
15438
16022
|
# For an audit check, specifies which mitigation actions to apply.
|
15439
|
-
# Those actions must be defined in your
|
16023
|
+
# Those actions must be defined in your Amazon Web Services accounts.
|
15440
16024
|
# @return [Hash<String,Array<String>>]
|
15441
16025
|
#
|
15442
16026
|
# @!attribute [rw] client_request_token
|
@@ -15518,8 +16102,9 @@ module Aws::IoT
|
|
15518
16102
|
# @!attribute [rw] client_request_token
|
15519
16103
|
# Each mitigation action task must have a unique client request token.
|
15520
16104
|
# If you try to create a new task with the same token as a task that
|
15521
|
-
# already exists, an exception occurs. If you omit this value,
|
15522
|
-
# SDKs will automatically generate a unique client
|
16105
|
+
# already exists, an exception occurs. If you omit this value, Amazon
|
16106
|
+
# Web Services SDKs will automatically generate a unique client
|
16107
|
+
# request.
|
15523
16108
|
#
|
15524
16109
|
# **A suitable default value is auto-generated.** You should normally
|
15525
16110
|
# not need to pass this option.
|
@@ -15883,7 +16468,7 @@ module Aws::IoT
|
|
15883
16468
|
# @return [Time]
|
15884
16469
|
#
|
15885
16470
|
# @!attribute [rw] role_arn
|
15886
|
-
# An IAM role
|
16471
|
+
# An IAM role IoT assumes to access your S3 files.
|
15887
16472
|
# @return [String]
|
15888
16473
|
#
|
15889
16474
|
class StreamInfo < Struct.new(
|
@@ -16074,6 +16659,27 @@ module Aws::IoT
|
|
16074
16659
|
include Aws::Structure
|
16075
16660
|
end
|
16076
16661
|
|
16662
|
+
# Performs an aggregation that will return a list of buckets. The list
|
16663
|
+
# of buckets is a ranked list of the number of occurrences of an
|
16664
|
+
# aggregation field value.
|
16665
|
+
#
|
16666
|
+
# @note When making an API call, you may pass TermsAggregation
|
16667
|
+
# data as a hash:
|
16668
|
+
#
|
16669
|
+
# {
|
16670
|
+
# max_buckets: 1,
|
16671
|
+
# }
|
16672
|
+
#
|
16673
|
+
# @!attribute [rw] max_buckets
|
16674
|
+
# The number of buckets to return in the response. Default to 10.
|
16675
|
+
# @return [Integer]
|
16676
|
+
#
|
16677
|
+
class TermsAggregation < Struct.new(
|
16678
|
+
:max_buckets)
|
16679
|
+
SENSITIVE = []
|
16680
|
+
include Aws::Structure
|
16681
|
+
end
|
16682
|
+
|
16077
16683
|
# @note When making an API call, you may pass TestAuthorizationRequest
|
16078
16684
|
# data as a hash:
|
16079
16685
|
#
|
@@ -16271,19 +16877,26 @@ module Aws::IoT
|
|
16271
16877
|
# The connectivity status of the thing.
|
16272
16878
|
#
|
16273
16879
|
# @!attribute [rw] connected
|
16274
|
-
# True if the thing is connected to the
|
16275
|
-
# is not connected.
|
16880
|
+
# True if the thing is connected to the Amazon Web Services IoT Core
|
16881
|
+
# service; false if it is not connected.
|
16276
16882
|
# @return [Boolean]
|
16277
16883
|
#
|
16278
16884
|
# @!attribute [rw] timestamp
|
16279
16885
|
# The epoch time (in milliseconds) when the thing last connected or
|
16280
|
-
# disconnected. If the thing has been disconnected for
|
16281
|
-
#
|
16886
|
+
# disconnected. If the thing has been disconnected for approximately
|
16887
|
+
# an hour, the time value might be missing.
|
16282
16888
|
# @return [Integer]
|
16283
16889
|
#
|
16890
|
+
# @!attribute [rw] disconnect_reason
|
16891
|
+
# The reason why the client is disconnected. If the thing has been
|
16892
|
+
# disconnected for approximately an hour, the `disconnectReason` value
|
16893
|
+
# might be missing.
|
16894
|
+
# @return [String]
|
16895
|
+
#
|
16284
16896
|
class ThingConnectivity < Struct.new(
|
16285
16897
|
:connected,
|
16286
|
-
:timestamp
|
16898
|
+
:timestamp,
|
16899
|
+
:disconnect_reason)
|
16287
16900
|
SENSITIVE = []
|
16288
16901
|
include Aws::Structure
|
16289
16902
|
end
|
@@ -16315,7 +16928,8 @@ module Aws::IoT
|
|
16315
16928
|
# @return [String]
|
16316
16929
|
#
|
16317
16930
|
# @!attribute [rw] connectivity
|
16318
|
-
# Indicates whether the thing is connected to the
|
16931
|
+
# Indicates whether the thing is connected to the Amazon Web Services
|
16932
|
+
# IoT Core service.
|
16319
16933
|
# @return [Types::ThingConnectivity]
|
16320
16934
|
#
|
16321
16935
|
class ThingDocument < Struct.new(
|
@@ -16502,7 +17116,7 @@ module Aws::IoT
|
|
16502
17116
|
# Thing connectivity indexing mode. Valid values are:
|
16503
17117
|
#
|
16504
17118
|
# * STATUS – Your thing index contains connectivity status. To enable
|
16505
|
-
# thing connectivity indexing, thingIndexMode must not be set to
|
17119
|
+
# thing connectivity indexing, *thingIndexMode* must not be set to
|
16506
17120
|
# OFF.
|
16507
17121
|
#
|
16508
17122
|
# * OFF - Thing connectivity status indexing is disabled.
|
@@ -17231,6 +17845,13 @@ module Aws::IoT
|
|
17231
17845
|
# "String" => "String",
|
17232
17846
|
# },
|
17233
17847
|
# },
|
17848
|
+
# open_search: {
|
17849
|
+
# role_arn: "AwsArn", # required
|
17850
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
17851
|
+
# index: "ElasticsearchIndex", # required
|
17852
|
+
# type: "ElasticsearchType", # required
|
17853
|
+
# id: "ElasticsearchId", # required
|
17854
|
+
# },
|
17234
17855
|
# },
|
17235
17856
|
# ],
|
17236
17857
|
# rule_disabled: false,
|
@@ -17402,12 +18023,19 @@ module Aws::IoT
|
|
17402
18023
|
# "String" => "String",
|
17403
18024
|
# },
|
17404
18025
|
# },
|
18026
|
+
# open_search: {
|
18027
|
+
# role_arn: "AwsArn", # required
|
18028
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
18029
|
+
# index: "ElasticsearchIndex", # required
|
18030
|
+
# type: "ElasticsearchType", # required
|
18031
|
+
# id: "ElasticsearchId", # required
|
18032
|
+
# },
|
17405
18033
|
# },
|
17406
18034
|
# }
|
17407
18035
|
#
|
17408
18036
|
# @!attribute [rw] sql
|
17409
18037
|
# The SQL statement used to query the topic. For more information, see
|
17410
|
-
# [
|
18038
|
+
# [IoT SQL Reference][1] in the *IoT Developer Guide*.
|
17411
18039
|
#
|
17412
18040
|
#
|
17413
18041
|
#
|
@@ -17475,7 +18103,7 @@ module Aws::IoT
|
|
17475
18103
|
# @return [String]
|
17476
18104
|
#
|
17477
18105
|
# @!attribute [rw] target_aws_account
|
17478
|
-
# The
|
18106
|
+
# The Amazon Web Services account.
|
17479
18107
|
# @return [String]
|
17480
18108
|
#
|
17481
18109
|
# @!attribute [rw] transfer_message
|
@@ -17515,7 +18143,7 @@ module Aws::IoT
|
|
17515
18143
|
include Aws::Structure
|
17516
18144
|
end
|
17517
18145
|
|
17518
|
-
# Data used to transfer a certificate to an
|
18146
|
+
# Data used to transfer a certificate to an Amazon Web Services account.
|
17519
18147
|
#
|
17520
18148
|
# @!attribute [rw] transfer_message
|
17521
18149
|
# The transfer message.
|
@@ -17605,7 +18233,7 @@ module Aws::IoT
|
|
17605
18233
|
#
|
17606
18234
|
# @!attribute [rw] role_arn
|
17607
18235
|
# The Amazon Resource Name (ARN) of the role that grants permission to
|
17608
|
-
#
|
18236
|
+
# IoT to access information about your devices, policies,
|
17609
18237
|
# certificates, and other items as required when performing an audit.
|
17610
18238
|
# @return [String]
|
17611
18239
|
#
|
@@ -17894,7 +18522,7 @@ module Aws::IoT
|
|
17894
18522
|
# **Note:** Setting the status to PENDING\_TRANSFER or
|
17895
18523
|
# PENDING\_ACTIVATION will result in an exception being thrown.
|
17896
18524
|
# PENDING\_TRANSFER and PENDING\_ACTIVATION are statuses used
|
17897
|
-
# internally by
|
18525
|
+
# internally by IoT. They are not intended for developer use.
|
17898
18526
|
#
|
17899
18527
|
# **Note:** The status value REGISTER\_INACTIVE is deprecated and
|
17900
18528
|
# should not be used.
|
@@ -18144,7 +18772,7 @@ module Aws::IoT
|
|
18144
18772
|
# @!attribute [rw] index_name
|
18145
18773
|
# The dynamic thing group index to update.
|
18146
18774
|
#
|
18147
|
-
# <note markdown="1"> Currently one index is supported:
|
18775
|
+
# <note markdown="1"> Currently one index is supported: `AWS_Things`.
|
18148
18776
|
#
|
18149
18777
|
# </note>
|
18150
18778
|
# @return [String]
|
@@ -18206,6 +18834,86 @@ module Aws::IoT
|
|
18206
18834
|
|
18207
18835
|
class UpdateEventConfigurationsResponse < Aws::EmptyStructure; end
|
18208
18836
|
|
18837
|
+
# @note When making an API call, you may pass UpdateFleetMetricRequest
|
18838
|
+
# data as a hash:
|
18839
|
+
#
|
18840
|
+
# {
|
18841
|
+
# metric_name: "FleetMetricName", # required
|
18842
|
+
# query_string: "QueryString",
|
18843
|
+
# aggregation_type: {
|
18844
|
+
# name: "Statistics", # required, accepts Statistics, Percentiles, Cardinality
|
18845
|
+
# values: ["AggregationTypeValue"],
|
18846
|
+
# },
|
18847
|
+
# period: 1,
|
18848
|
+
# aggregation_field: "AggregationField",
|
18849
|
+
# description: "FleetMetricDescription",
|
18850
|
+
# query_version: "QueryVersion",
|
18851
|
+
# index_name: "IndexName", # required
|
18852
|
+
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
18853
|
+
# expected_version: 1,
|
18854
|
+
# }
|
18855
|
+
#
|
18856
|
+
# @!attribute [rw] metric_name
|
18857
|
+
# The name of the fleet metric to update.
|
18858
|
+
# @return [String]
|
18859
|
+
#
|
18860
|
+
# @!attribute [rw] query_string
|
18861
|
+
# The search query string.
|
18862
|
+
# @return [String]
|
18863
|
+
#
|
18864
|
+
# @!attribute [rw] aggregation_type
|
18865
|
+
# The type of the aggregation query.
|
18866
|
+
# @return [Types::AggregationType]
|
18867
|
+
#
|
18868
|
+
# @!attribute [rw] period
|
18869
|
+
# The time in seconds between fleet metric emissions. Range \[60(1
|
18870
|
+
# min), 86400(1 day)\] and must be multiple of 60.
|
18871
|
+
# @return [Integer]
|
18872
|
+
#
|
18873
|
+
# @!attribute [rw] aggregation_field
|
18874
|
+
# The field to aggregate.
|
18875
|
+
# @return [String]
|
18876
|
+
#
|
18877
|
+
# @!attribute [rw] description
|
18878
|
+
# The description of the fleet metric.
|
18879
|
+
# @return [String]
|
18880
|
+
#
|
18881
|
+
# @!attribute [rw] query_version
|
18882
|
+
# The version of the query.
|
18883
|
+
# @return [String]
|
18884
|
+
#
|
18885
|
+
# @!attribute [rw] index_name
|
18886
|
+
# The name of the index to search.
|
18887
|
+
# @return [String]
|
18888
|
+
#
|
18889
|
+
# @!attribute [rw] unit
|
18890
|
+
# Used to support unit transformation such as milliseconds to seconds.
|
18891
|
+
# The unit must be supported by [CW metric][1].
|
18892
|
+
#
|
18893
|
+
#
|
18894
|
+
#
|
18895
|
+
# [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
|
18896
|
+
# @return [String]
|
18897
|
+
#
|
18898
|
+
# @!attribute [rw] expected_version
|
18899
|
+
# The expected version of the fleet metric record in the registry.
|
18900
|
+
# @return [Integer]
|
18901
|
+
#
|
18902
|
+
class UpdateFleetMetricRequest < Struct.new(
|
18903
|
+
:metric_name,
|
18904
|
+
:query_string,
|
18905
|
+
:aggregation_type,
|
18906
|
+
:period,
|
18907
|
+
:aggregation_field,
|
18908
|
+
:description,
|
18909
|
+
:query_version,
|
18910
|
+
:index_name,
|
18911
|
+
:unit,
|
18912
|
+
:expected_version)
|
18913
|
+
SENSITIVE = []
|
18914
|
+
include Aws::Structure
|
18915
|
+
end
|
18916
|
+
|
18209
18917
|
# @note When making an API call, you may pass UpdateIndexingConfigurationRequest
|
18210
18918
|
# data as a hash:
|
18211
18919
|
#
|
@@ -18328,9 +19036,9 @@ module Aws::IoT
|
|
18328
19036
|
# @!attribute [rw] namespace_id
|
18329
19037
|
# The namespace used to indicate that a job is a customer-managed job.
|
18330
19038
|
#
|
18331
|
-
# When you specify a value for this parameter,
|
18332
|
-
# notifications to MQTT topics that contain the value
|
18333
|
-
# format.
|
19039
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
19040
|
+
# Core sends jobs notifications to MQTT topics that contain the value
|
19041
|
+
# in the following format.
|
18334
19042
|
#
|
18335
19043
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
18336
19044
|
#
|
@@ -19193,6 +19901,14 @@ module Aws::IoT
|
|
19193
19901
|
# The type of violation event.
|
19194
19902
|
# @return [String]
|
19195
19903
|
#
|
19904
|
+
# @!attribute [rw] verification_state
|
19905
|
+
# The verification state of the violation (detect alarm).
|
19906
|
+
# @return [String]
|
19907
|
+
#
|
19908
|
+
# @!attribute [rw] verification_state_description
|
19909
|
+
# The description of the verification state of the violation.
|
19910
|
+
# @return [String]
|
19911
|
+
#
|
19196
19912
|
# @!attribute [rw] violation_event_time
|
19197
19913
|
# The time the violation event occurred.
|
19198
19914
|
# @return [Time]
|
@@ -19205,6 +19921,8 @@ module Aws::IoT
|
|
19205
19921
|
:metric_value,
|
19206
19922
|
:violation_event_additional_info,
|
19207
19923
|
:violation_event_type,
|
19924
|
+
:verification_state,
|
19925
|
+
:verification_state_description,
|
19208
19926
|
:violation_event_time)
|
19209
19927
|
SENSITIVE = []
|
19210
19928
|
include Aws::Structure
|