aws-sdk-iot 1.110.0 → 1.112.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iot/client.rb +102 -33
- data/lib/aws-sdk-iot/client_api.rb +26 -0
- data/lib/aws-sdk-iot/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-iot/types.rb +164 -36
- data/lib/aws-sdk-iot.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7571f69633431fd900d72325637a9f5f0a829fb6794ed7900a4e1c5c4033ef8c
|
4
|
+
data.tar.gz: 0ebb8ddeccd9377a0509e1571525ff550a87a166e60cee981d665ec324777052
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 87c6c9c0808e967ca8d698432173edde9c5566b900e8021f831d9cac90d73cbcb2d94517d03d29402641acab6e086921fb3d764b397a6965a322f8c5c4703a61
|
7
|
+
data.tar.gz: 8129f8475f90fc898da90fce1bad02408bc75784cbbec8d3abc37881173672d94048d9b79b2796420aff17f500878e6225eb36b3414354d497484020e6fed907
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.112.0 (2023-11-14)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release introduces new attributes in API CreateSecurityProfile, UpdateSecurityProfile and DescribeSecurityProfile to support management of Metrics Export for AWS IoT Device Defender Detect.
|
8
|
+
|
9
|
+
1.111.0 (2023-09-27)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Added support for IoT Rules Engine Kafka Action Headers
|
13
|
+
|
4
14
|
1.110.0 (2023-07-11)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.112.0
|
data/lib/aws-sdk-iot/client.rb
CHANGED
@@ -1225,9 +1225,9 @@ module Aws::IoT
|
|
1225
1225
|
# action.
|
1226
1226
|
#
|
1227
1227
|
# <note markdown="1"> The CSR must include a public key that is either an RSA key with a
|
1228
|
-
# length of at least 2048 bits or an ECC key from NIST P-256
|
1229
|
-
# P-384 curves. For supported certificates, consult [
|
1230
|
-
# signing algorithms supported by IoT][2].
|
1228
|
+
# length of at least 2048 bits or an ECC key from NIST P-256, NIST
|
1229
|
+
# P-384, or NIST P-521 curves. For supported certificates, consult [
|
1230
|
+
# Certificate signing algorithms supported by IoT][2].
|
1231
1231
|
#
|
1232
1232
|
# </note>
|
1233
1233
|
#
|
@@ -1936,20 +1936,18 @@ module Aws::IoT
|
|
1936
1936
|
# The ARN of the job to use as the basis for the job template.
|
1937
1937
|
#
|
1938
1938
|
# @option params [String] :document_source
|
1939
|
-
# An S3 link
|
1940
|
-
# don't specify a value for
|
1939
|
+
# An S3 link, or S3 object URL, to the job document. The link is an
|
1940
|
+
# Amazon S3 object URL and is required if you don't specify a value for
|
1941
|
+
# `document`.
|
1941
1942
|
#
|
1942
|
-
#
|
1943
|
-
#
|
1943
|
+
# For example, `--document-source
|
1944
|
+
# https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0`
|
1944
1945
|
#
|
1945
|
-
#
|
1946
|
+
# For more information, see [Methods for accessing a bucket][1].
|
1946
1947
|
#
|
1947
|
-
# `$\{aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key\}`
|
1948
1948
|
#
|
1949
|
-
# where *bucket* is your bucket name and *key* is the object in the
|
1950
|
-
# bucket to which you are linking.
|
1951
1949
|
#
|
1952
|
-
#
|
1950
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html
|
1953
1951
|
#
|
1954
1952
|
# @option params [String] :document
|
1955
1953
|
# The job document. Required if you don't specify a value for
|
@@ -2248,7 +2246,8 @@ module Aws::IoT
|
|
2248
2246
|
# create an OTA update job.
|
2249
2247
|
#
|
2250
2248
|
# @option params [Hash<String,String>] :additional_parameters
|
2251
|
-
# A list of additional OTA update parameters which are name-value
|
2249
|
+
# A list of additional OTA update parameters, which are name-value
|
2250
|
+
# pairs. They won't be sent to devices as a part of the Job document.
|
2252
2251
|
#
|
2253
2252
|
# @option params [Array<Types::Tag>] :tags
|
2254
2253
|
# Metadata which can be used to manage updates.
|
@@ -2382,7 +2381,7 @@ module Aws::IoT
|
|
2382
2381
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2383
2382
|
#
|
2384
2383
|
# @option params [required, String] :package_name
|
2385
|
-
# The name of the new package.
|
2384
|
+
# The name of the new software package.
|
2386
2385
|
#
|
2387
2386
|
# @option params [String] :description
|
2388
2387
|
# A summary of the package being created. This can be used to outline
|
@@ -2439,7 +2438,7 @@ module Aws::IoT
|
|
2439
2438
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2440
2439
|
#
|
2441
2440
|
# @option params [required, String] :package_name
|
2442
|
-
# The name of the associated package.
|
2441
|
+
# The name of the associated software package.
|
2443
2442
|
#
|
2444
2443
|
# @option params [required, String] :version_name
|
2445
2444
|
# The name of the new package version.
|
@@ -2999,6 +2998,9 @@ module Aws::IoT
|
|
2999
2998
|
# @option params [Array<Types::Tag>] :tags
|
3000
2999
|
# Metadata that can be used to manage the security profile.
|
3001
3000
|
#
|
3001
|
+
# @option params [Types::MetricsExportConfig] :metrics_export_config
|
3002
|
+
# Specifies the MQTT topic and role ARN required for metric export.
|
3003
|
+
#
|
3002
3004
|
# @return [Types::CreateSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3003
3005
|
#
|
3004
3006
|
# * {Types::CreateSecurityProfileResponse#security_profile_name #security_profile_name} => String
|
@@ -3038,6 +3040,7 @@ module Aws::IoT
|
|
3038
3040
|
# },
|
3039
3041
|
# },
|
3040
3042
|
# suppress_alerts: false,
|
3043
|
+
# export_metric: false,
|
3041
3044
|
# },
|
3042
3045
|
# ],
|
3043
3046
|
# alert_targets: {
|
@@ -3054,6 +3057,7 @@ module Aws::IoT
|
|
3054
3057
|
# dimension_name: "DimensionName", # required
|
3055
3058
|
# operator: "IN", # accepts IN, NOT_IN
|
3056
3059
|
# },
|
3060
|
+
# export_metric: false,
|
3057
3061
|
# },
|
3058
3062
|
# ],
|
3059
3063
|
# tags: [
|
@@ -3062,6 +3066,10 @@ module Aws::IoT
|
|
3062
3066
|
# value: "TagValue",
|
3063
3067
|
# },
|
3064
3068
|
# ],
|
3069
|
+
# metrics_export_config: {
|
3070
|
+
# mqtt_topic: "MqttTopic", # required
|
3071
|
+
# role_arn: "RoleArn", # required
|
3072
|
+
# },
|
3065
3073
|
# })
|
3066
3074
|
#
|
3067
3075
|
# @example Response structure
|
@@ -3222,6 +3230,9 @@ module Aws::IoT
|
|
3222
3230
|
# <note markdown="1"> This is a control plane operation. See [Authorization][1] for
|
3223
3231
|
# information about authorizing control plane actions.
|
3224
3232
|
#
|
3233
|
+
# If the `ThingGroup` that you create has the exact same attributes as
|
3234
|
+
# an existing `ThingGroup`, you will get a 200 success response.
|
3235
|
+
#
|
3225
3236
|
# </note>
|
3226
3237
|
#
|
3227
3238
|
# Requires permission to access the [CreateThingGroup][2] action.
|
@@ -3558,6 +3569,12 @@ module Aws::IoT
|
|
3558
3569
|
# client_properties: { # required
|
3559
3570
|
# "String" => "String",
|
3560
3571
|
# },
|
3572
|
+
# headers: [
|
3573
|
+
# {
|
3574
|
+
# key: "KafkaHeaderKey", # required
|
3575
|
+
# value: "KafkaHeaderValue", # required
|
3576
|
+
# },
|
3577
|
+
# ],
|
3561
3578
|
# },
|
3562
3579
|
# open_search: {
|
3563
3580
|
# role_arn: "AwsArn", # required
|
@@ -3761,6 +3778,12 @@ module Aws::IoT
|
|
3761
3778
|
# client_properties: { # required
|
3762
3779
|
# "String" => "String",
|
3763
3780
|
# },
|
3781
|
+
# headers: [
|
3782
|
+
# {
|
3783
|
+
# key: "KafkaHeaderKey", # required
|
3784
|
+
# value: "KafkaHeaderValue", # required
|
3785
|
+
# },
|
3786
|
+
# ],
|
3764
3787
|
# },
|
3765
3788
|
# open_search: {
|
3766
3789
|
# role_arn: "AwsArn", # required
|
@@ -4436,7 +4459,7 @@ module Aws::IoT
|
|
4436
4459
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4437
4460
|
#
|
4438
4461
|
# @option params [required, String] :package_name
|
4439
|
-
# The name of the target package.
|
4462
|
+
# The name of the target software package.
|
4440
4463
|
#
|
4441
4464
|
# @option params [String] :client_token
|
4442
4465
|
# A unique case-sensitive identifier that you can provide to ensure the
|
@@ -4465,11 +4488,11 @@ module Aws::IoT
|
|
4465
4488
|
# Deletes a specific version from a software package.
|
4466
4489
|
#
|
4467
4490
|
# **Note:** If a package version is designated as default, you must
|
4468
|
-
# remove the designation from the package using the
|
4469
|
-
# action.
|
4491
|
+
# remove the designation from the software package using the
|
4492
|
+
# UpdatePackage action.
|
4470
4493
|
#
|
4471
4494
|
# @option params [required, String] :package_name
|
4472
|
-
# The name of the associated package.
|
4495
|
+
# The name of the associated software package.
|
4473
4496
|
#
|
4474
4497
|
# @option params [required, String] :version_name
|
4475
4498
|
# The name of the target package version.
|
@@ -4930,7 +4953,7 @@ module Aws::IoT
|
|
4930
4953
|
# @example Request syntax with placeholder values
|
4931
4954
|
#
|
4932
4955
|
# resp = client.delete_v2_logging_level({
|
4933
|
-
# target_type: "DEFAULT", # required, accepts DEFAULT, THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID
|
4956
|
+
# target_type: "DEFAULT", # required, accepts DEFAULT, THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, EVENT_TYPE, DEVICE_DEFENDER
|
4934
4957
|
# target_name: "LogTargetName", # required
|
4935
4958
|
# })
|
4936
4959
|
#
|
@@ -5727,7 +5750,8 @@ module Aws::IoT
|
|
5727
5750
|
#
|
5728
5751
|
# We strongly recommend that customers use the newer `iot:Data-ATS`
|
5729
5752
|
# endpoint type to avoid issues related to the widespread distrust of
|
5730
|
-
# Symantec certificate authorities.
|
5753
|
+
# Symantec certificate authorities. ATS Signed Certificates are more
|
5754
|
+
# secure and are trusted by most popular browsers.
|
5731
5755
|
#
|
5732
5756
|
# @return [Types::DescribeEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5733
5757
|
#
|
@@ -6381,6 +6405,7 @@ module Aws::IoT
|
|
6381
6405
|
# * {Types::DescribeSecurityProfileResponse#version #version} => Integer
|
6382
6406
|
# * {Types::DescribeSecurityProfileResponse#creation_date #creation_date} => Time
|
6383
6407
|
# * {Types::DescribeSecurityProfileResponse#last_modified_date #last_modified_date} => Time
|
6408
|
+
# * {Types::DescribeSecurityProfileResponse#metrics_export_config #metrics_export_config} => Types::MetricsExportConfig
|
6384
6409
|
#
|
6385
6410
|
# @example Request syntax with placeholder values
|
6386
6411
|
#
|
@@ -6415,6 +6440,7 @@ module Aws::IoT
|
|
6415
6440
|
# resp.behaviors[0].criteria.statistical_threshold.statistic #=> String
|
6416
6441
|
# resp.behaviors[0].criteria.ml_detection_config.confidence_level #=> String, one of "LOW", "MEDIUM", "HIGH"
|
6417
6442
|
# resp.behaviors[0].suppress_alerts #=> Boolean
|
6443
|
+
# resp.behaviors[0].export_metric #=> Boolean
|
6418
6444
|
# resp.alert_targets #=> Hash
|
6419
6445
|
# resp.alert_targets["AlertTargetType"].alert_target_arn #=> String
|
6420
6446
|
# resp.alert_targets["AlertTargetType"].role_arn #=> String
|
@@ -6424,9 +6450,12 @@ module Aws::IoT
|
|
6424
6450
|
# resp.additional_metrics_to_retain_v2[0].metric #=> String
|
6425
6451
|
# resp.additional_metrics_to_retain_v2[0].metric_dimension.dimension_name #=> String
|
6426
6452
|
# resp.additional_metrics_to_retain_v2[0].metric_dimension.operator #=> String, one of "IN", "NOT_IN"
|
6453
|
+
# resp.additional_metrics_to_retain_v2[0].export_metric #=> Boolean
|
6427
6454
|
# resp.version #=> Integer
|
6428
6455
|
# resp.creation_date #=> Time
|
6429
6456
|
# resp.last_modified_date #=> Time
|
6457
|
+
# resp.metrics_export_config.mqtt_topic #=> String
|
6458
|
+
# resp.metrics_export_config.role_arn #=> String
|
6430
6459
|
#
|
6431
6460
|
# @overload describe_security_profile(params = {})
|
6432
6461
|
# @param [Hash] params ({})
|
@@ -7271,7 +7300,7 @@ module Aws::IoT
|
|
7271
7300
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7272
7301
|
#
|
7273
7302
|
# @option params [required, String] :package_name
|
7274
|
-
# The name of the target package.
|
7303
|
+
# The name of the target software package.
|
7275
7304
|
#
|
7276
7305
|
# @return [Types::GetPackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7277
7306
|
#
|
@@ -7754,6 +7783,9 @@ module Aws::IoT
|
|
7754
7783
|
# resp.rule.actions[0].kafka.partition #=> String
|
7755
7784
|
# resp.rule.actions[0].kafka.client_properties #=> Hash
|
7756
7785
|
# resp.rule.actions[0].kafka.client_properties["String"] #=> String
|
7786
|
+
# resp.rule.actions[0].kafka.headers #=> Array
|
7787
|
+
# resp.rule.actions[0].kafka.headers[0].key #=> String
|
7788
|
+
# resp.rule.actions[0].kafka.headers[0].value #=> String
|
7757
7789
|
# resp.rule.actions[0].open_search.role_arn #=> String
|
7758
7790
|
# resp.rule.actions[0].open_search.endpoint #=> String
|
7759
7791
|
# resp.rule.actions[0].open_search.index #=> String
|
@@ -7876,6 +7908,9 @@ module Aws::IoT
|
|
7876
7908
|
# resp.rule.error_action.kafka.partition #=> String
|
7877
7909
|
# resp.rule.error_action.kafka.client_properties #=> Hash
|
7878
7910
|
# resp.rule.error_action.kafka.client_properties["String"] #=> String
|
7911
|
+
# resp.rule.error_action.kafka.headers #=> Array
|
7912
|
+
# resp.rule.error_action.kafka.headers[0].key #=> String
|
7913
|
+
# resp.rule.error_action.kafka.headers[0].value #=> String
|
7879
7914
|
# resp.rule.error_action.open_search.role_arn #=> String
|
7880
7915
|
# resp.rule.error_action.open_search.endpoint #=> String
|
7881
7916
|
# resp.rule.error_action.open_search.index #=> String
|
@@ -8043,6 +8078,7 @@ module Aws::IoT
|
|
8043
8078
|
# resp.active_violations[0].behavior.criteria.statistical_threshold.statistic #=> String
|
8044
8079
|
# resp.active_violations[0].behavior.criteria.ml_detection_config.confidence_level #=> String, one of "LOW", "MEDIUM", "HIGH"
|
8045
8080
|
# resp.active_violations[0].behavior.suppress_alerts #=> Boolean
|
8081
|
+
# resp.active_violations[0].behavior.export_metric #=> Boolean
|
8046
8082
|
# resp.active_violations[0].last_violation_value.count #=> Integer
|
8047
8083
|
# resp.active_violations[0].last_violation_value.cidrs #=> Array
|
8048
8084
|
# resp.active_violations[0].last_violation_value.cidrs[0] #=> String
|
@@ -9733,7 +9769,7 @@ module Aws::IoT
|
|
9733
9769
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9734
9770
|
#
|
9735
9771
|
# @option params [required, String] :package_name
|
9736
|
-
# The name of the target package.
|
9772
|
+
# The name of the target software package.
|
9737
9773
|
#
|
9738
9774
|
# @option params [String] :status
|
9739
9775
|
# The status of the package version. For more information, see [Package
|
@@ -11268,7 +11304,7 @@ module Aws::IoT
|
|
11268
11304
|
# @example Request syntax with placeholder values
|
11269
11305
|
#
|
11270
11306
|
# resp = client.list_v2_logging_levels({
|
11271
|
-
# target_type: "DEFAULT", # accepts DEFAULT, THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID
|
11307
|
+
# target_type: "DEFAULT", # accepts DEFAULT, THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, EVENT_TYPE, DEVICE_DEFENDER
|
11272
11308
|
# next_token: "NextToken",
|
11273
11309
|
# max_results: 1,
|
11274
11310
|
# })
|
@@ -11276,7 +11312,7 @@ module Aws::IoT
|
|
11276
11312
|
# @example Response structure
|
11277
11313
|
#
|
11278
11314
|
# resp.log_target_configurations #=> Array
|
11279
|
-
# resp.log_target_configurations[0].log_target.target_type #=> String, one of "DEFAULT", "THING_GROUP", "CLIENT_ID", "SOURCE_IP", "PRINCIPAL_ID"
|
11315
|
+
# resp.log_target_configurations[0].log_target.target_type #=> String, one of "DEFAULT", "THING_GROUP", "CLIENT_ID", "SOURCE_IP", "PRINCIPAL_ID", "EVENT_TYPE", "DEVICE_DEFENDER"
|
11280
11316
|
# resp.log_target_configurations[0].log_target.target_name #=> String
|
11281
11317
|
# resp.log_target_configurations[0].log_level #=> String, one of "DEBUG", "INFO", "ERROR", "WARN", "DISABLED"
|
11282
11318
|
# resp.next_token #=> String
|
@@ -11376,6 +11412,7 @@ module Aws::IoT
|
|
11376
11412
|
# resp.violation_events[0].behavior.criteria.statistical_threshold.statistic #=> String
|
11377
11413
|
# resp.violation_events[0].behavior.criteria.ml_detection_config.confidence_level #=> String, one of "LOW", "MEDIUM", "HIGH"
|
11378
11414
|
# resp.violation_events[0].behavior.suppress_alerts #=> Boolean
|
11415
|
+
# resp.violation_events[0].behavior.export_metric #=> Boolean
|
11379
11416
|
# resp.violation_events[0].metric_value.count #=> Integer
|
11380
11417
|
# resp.violation_events[0].metric_value.cidrs #=> Array
|
11381
11418
|
# resp.violation_events[0].metric_value.cidrs[0] #=> String
|
@@ -12013,6 +12050,12 @@ module Aws::IoT
|
|
12013
12050
|
# client_properties: { # required
|
12014
12051
|
# "String" => "String",
|
12015
12052
|
# },
|
12053
|
+
# headers: [
|
12054
|
+
# {
|
12055
|
+
# key: "KafkaHeaderKey", # required
|
12056
|
+
# value: "KafkaHeaderValue", # required
|
12057
|
+
# },
|
12058
|
+
# ],
|
12016
12059
|
# },
|
12017
12060
|
# open_search: {
|
12018
12061
|
# role_arn: "AwsArn", # required
|
@@ -12216,6 +12259,12 @@ module Aws::IoT
|
|
12216
12259
|
# client_properties: { # required
|
12217
12260
|
# "String" => "String",
|
12218
12261
|
# },
|
12262
|
+
# headers: [
|
12263
|
+
# {
|
12264
|
+
# key: "KafkaHeaderKey", # required
|
12265
|
+
# value: "KafkaHeaderValue", # required
|
12266
|
+
# },
|
12267
|
+
# ],
|
12219
12268
|
# },
|
12220
12269
|
# open_search: {
|
12221
12270
|
# role_arn: "AwsArn", # required
|
@@ -12270,7 +12319,8 @@ module Aws::IoT
|
|
12270
12319
|
# no additional results.
|
12271
12320
|
#
|
12272
12321
|
# @option params [Integer] :max_results
|
12273
|
-
# The maximum number of results to return at one time.
|
12322
|
+
# The maximum number of results to return at one time. The response
|
12323
|
+
# might contain fewer results but will never contain more.
|
12274
12324
|
#
|
12275
12325
|
# @option params [String] :query_version
|
12276
12326
|
# The query version.
|
@@ -12443,7 +12493,7 @@ module Aws::IoT
|
|
12443
12493
|
#
|
12444
12494
|
# resp = client.set_v2_logging_level({
|
12445
12495
|
# log_target: { # required
|
12446
|
-
# target_type: "DEFAULT", # required, accepts DEFAULT, THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID
|
12496
|
+
# target_type: "DEFAULT", # required, accepts DEFAULT, THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, EVENT_TYPE, DEVICE_DEFENDER
|
12447
12497
|
# target_name: "LogTargetName",
|
12448
12498
|
# },
|
12449
12499
|
# log_level: "DEBUG", # required, accepts DEBUG, INFO, ERROR, WARN, DISABLED
|
@@ -13886,7 +13936,7 @@ module Aws::IoT
|
|
13886
13936
|
req.send_request(options)
|
13887
13937
|
end
|
13888
13938
|
|
13889
|
-
# Updates the supported fields for a specific package.
|
13939
|
+
# Updates the supported fields for a specific software package.
|
13890
13940
|
#
|
13891
13941
|
# Requires permission to access the [UpdatePackage][1] and
|
13892
13942
|
# [GetIndexingConfiguration][1] actions.
|
@@ -13896,7 +13946,7 @@ module Aws::IoT
|
|
13896
13946
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13897
13947
|
#
|
13898
13948
|
# @option params [required, String] :package_name
|
13899
|
-
# The name of the target package.
|
13949
|
+
# The name of the target software package.
|
13900
13950
|
#
|
13901
13951
|
# @option params [String] :description
|
13902
13952
|
# The package description.
|
@@ -13942,7 +13992,7 @@ module Aws::IoT
|
|
13942
13992
|
req.send_request(options)
|
13943
13993
|
end
|
13944
13994
|
|
13945
|
-
# Updates the package configuration.
|
13995
|
+
# Updates the software package configuration.
|
13946
13996
|
#
|
13947
13997
|
# Requires permission to access the [UpdatePackageConfiguration][1] and
|
13948
13998
|
# [iam:PassRole][2] actions.
|
@@ -14003,8 +14053,8 @@ module Aws::IoT
|
|
14003
14053
|
#
|
14004
14054
|
# @option params [Hash<String,String>] :attributes
|
14005
14055
|
# Metadata that can be used to define a package version’s configuration.
|
14006
|
-
# For example, the S3 file location, configuration options that
|
14007
|
-
# being sent to the device or fleet.
|
14056
|
+
# For example, the Amazon S3 file location, configuration options that
|
14057
|
+
# are being sent to the device or fleet.
|
14008
14058
|
#
|
14009
14059
|
# **Note:** Attributes can be updated only when the package version is
|
14010
14060
|
# in a draft state.
|
@@ -14274,6 +14324,12 @@ module Aws::IoT
|
|
14274
14324
|
# value that is different from the actual version, a
|
14275
14325
|
# `VersionConflictException` is thrown.
|
14276
14326
|
#
|
14327
|
+
# @option params [Types::MetricsExportConfig] :metrics_export_config
|
14328
|
+
# Specifies the MQTT topic and role ARN required for metric export.
|
14329
|
+
#
|
14330
|
+
# @option params [Boolean] :delete_metrics_export_config
|
14331
|
+
# Set the value as true to delete metrics export related configurations.
|
14332
|
+
#
|
14277
14333
|
# @return [Types::UpdateSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
14278
14334
|
#
|
14279
14335
|
# * {Types::UpdateSecurityProfileResponse#security_profile_name #security_profile_name} => String
|
@@ -14286,6 +14342,7 @@ module Aws::IoT
|
|
14286
14342
|
# * {Types::UpdateSecurityProfileResponse#version #version} => Integer
|
14287
14343
|
# * {Types::UpdateSecurityProfileResponse#creation_date #creation_date} => Time
|
14288
14344
|
# * {Types::UpdateSecurityProfileResponse#last_modified_date #last_modified_date} => Time
|
14345
|
+
# * {Types::UpdateSecurityProfileResponse#metrics_export_config #metrics_export_config} => Types::MetricsExportConfig
|
14289
14346
|
#
|
14290
14347
|
# @example Request syntax with placeholder values
|
14291
14348
|
#
|
@@ -14321,6 +14378,7 @@ module Aws::IoT
|
|
14321
14378
|
# },
|
14322
14379
|
# },
|
14323
14380
|
# suppress_alerts: false,
|
14381
|
+
# export_metric: false,
|
14324
14382
|
# },
|
14325
14383
|
# ],
|
14326
14384
|
# alert_targets: {
|
@@ -14337,12 +14395,18 @@ module Aws::IoT
|
|
14337
14395
|
# dimension_name: "DimensionName", # required
|
14338
14396
|
# operator: "IN", # accepts IN, NOT_IN
|
14339
14397
|
# },
|
14398
|
+
# export_metric: false,
|
14340
14399
|
# },
|
14341
14400
|
# ],
|
14342
14401
|
# delete_behaviors: false,
|
14343
14402
|
# delete_alert_targets: false,
|
14344
14403
|
# delete_additional_metrics_to_retain: false,
|
14345
14404
|
# expected_version: 1,
|
14405
|
+
# metrics_export_config: {
|
14406
|
+
# mqtt_topic: "MqttTopic", # required
|
14407
|
+
# role_arn: "RoleArn", # required
|
14408
|
+
# },
|
14409
|
+
# delete_metrics_export_config: false,
|
14346
14410
|
# })
|
14347
14411
|
#
|
14348
14412
|
# @example Response structure
|
@@ -14372,6 +14436,7 @@ module Aws::IoT
|
|
14372
14436
|
# resp.behaviors[0].criteria.statistical_threshold.statistic #=> String
|
14373
14437
|
# resp.behaviors[0].criteria.ml_detection_config.confidence_level #=> String, one of "LOW", "MEDIUM", "HIGH"
|
14374
14438
|
# resp.behaviors[0].suppress_alerts #=> Boolean
|
14439
|
+
# resp.behaviors[0].export_metric #=> Boolean
|
14375
14440
|
# resp.alert_targets #=> Hash
|
14376
14441
|
# resp.alert_targets["AlertTargetType"].alert_target_arn #=> String
|
14377
14442
|
# resp.alert_targets["AlertTargetType"].role_arn #=> String
|
@@ -14381,9 +14446,12 @@ module Aws::IoT
|
|
14381
14446
|
# resp.additional_metrics_to_retain_v2[0].metric #=> String
|
14382
14447
|
# resp.additional_metrics_to_retain_v2[0].metric_dimension.dimension_name #=> String
|
14383
14448
|
# resp.additional_metrics_to_retain_v2[0].metric_dimension.operator #=> String, one of "IN", "NOT_IN"
|
14449
|
+
# resp.additional_metrics_to_retain_v2[0].export_metric #=> Boolean
|
14384
14450
|
# resp.version #=> Integer
|
14385
14451
|
# resp.creation_date #=> Time
|
14386
14452
|
# resp.last_modified_date #=> Time
|
14453
|
+
# resp.metrics_export_config.mqtt_topic #=> String
|
14454
|
+
# resp.metrics_export_config.role_arn #=> String
|
14387
14455
|
#
|
14388
14456
|
# @overload update_security_profile(params = {})
|
14389
14457
|
# @param [Hash] params ({})
|
@@ -14715,6 +14783,7 @@ module Aws::IoT
|
|
14715
14783
|
# },
|
14716
14784
|
# },
|
14717
14785
|
# suppress_alerts: false,
|
14786
|
+
# export_metric: false,
|
14718
14787
|
# },
|
14719
14788
|
# ],
|
14720
14789
|
# })
|
@@ -14745,7 +14814,7 @@ module Aws::IoT
|
|
14745
14814
|
params: params,
|
14746
14815
|
config: config)
|
14747
14816
|
context[:gem_name] = 'aws-sdk-iot'
|
14748
|
-
context[:gem_version] = '1.
|
14817
|
+
context[:gem_version] = '1.112.0'
|
14749
14818
|
Seahorse::Client::Request.new(handlers, context)
|
14750
14819
|
end
|
14751
14820
|
|
@@ -335,6 +335,7 @@ module Aws::IoT
|
|
335
335
|
DeleteJobExecutionRequest = Shapes::StructureShape.new(name: 'DeleteJobExecutionRequest')
|
336
336
|
DeleteJobRequest = Shapes::StructureShape.new(name: 'DeleteJobRequest')
|
337
337
|
DeleteJobTemplateRequest = Shapes::StructureShape.new(name: 'DeleteJobTemplateRequest')
|
338
|
+
DeleteMetricsExportConfig = Shapes::BooleanShape.new(name: 'DeleteMetricsExportConfig')
|
338
339
|
DeleteMitigationActionRequest = Shapes::StructureShape.new(name: 'DeleteMitigationActionRequest')
|
339
340
|
DeleteMitigationActionResponse = Shapes::StructureShape.new(name: 'DeleteMitigationActionResponse')
|
340
341
|
DeleteOTAUpdateRequest = Shapes::StructureShape.new(name: 'DeleteOTAUpdateRequest')
|
@@ -523,6 +524,7 @@ module Aws::IoT
|
|
523
524
|
ExpiresInSeconds = Shapes::IntegerShape.new(name: 'ExpiresInSeconds')
|
524
525
|
ExplicitDeny = Shapes::StructureShape.new(name: 'ExplicitDeny')
|
525
526
|
ExponentialRolloutRate = Shapes::StructureShape.new(name: 'ExponentialRolloutRate')
|
527
|
+
ExportMetric = Shapes::BooleanShape.new(name: 'ExportMetric')
|
526
528
|
FailedChecksCount = Shapes::IntegerShape.new(name: 'FailedChecksCount')
|
527
529
|
FailedFindingsCount = Shapes::IntegerShape.new(name: 'FailedFindingsCount')
|
528
530
|
FailedThings = Shapes::IntegerShape.new(name: 'FailedThings')
|
@@ -670,6 +672,10 @@ module Aws::IoT
|
|
670
672
|
JobTemplateSummaryList = Shapes::ListShape.new(name: 'JobTemplateSummaryList')
|
671
673
|
JsonDocument = Shapes::StringShape.new(name: 'JsonDocument')
|
672
674
|
KafkaAction = Shapes::StructureShape.new(name: 'KafkaAction')
|
675
|
+
KafkaActionHeader = Shapes::StructureShape.new(name: 'KafkaActionHeader')
|
676
|
+
KafkaHeaderKey = Shapes::StringShape.new(name: 'KafkaHeaderKey')
|
677
|
+
KafkaHeaderValue = Shapes::StringShape.new(name: 'KafkaHeaderValue')
|
678
|
+
KafkaHeaders = Shapes::ListShape.new(name: 'KafkaHeaders')
|
673
679
|
Key = Shapes::StringShape.new(name: 'Key')
|
674
680
|
KeyName = Shapes::StringShape.new(name: 'KeyName')
|
675
681
|
KeyPair = Shapes::StructureShape.new(name: 'KeyPair')
|
@@ -835,6 +841,7 @@ module Aws::IoT
|
|
835
841
|
MetricNames = Shapes::ListShape.new(name: 'MetricNames')
|
836
842
|
MetricToRetain = Shapes::StructureShape.new(name: 'MetricToRetain')
|
837
843
|
MetricValue = Shapes::StructureShape.new(name: 'MetricValue')
|
844
|
+
MetricsExportConfig = Shapes::StructureShape.new(name: 'MetricsExportConfig')
|
838
845
|
Minimum = Shapes::FloatShape.new(name: 'Minimum')
|
839
846
|
MinimumNumberOfExecutedThings = Shapes::IntegerShape.new(name: 'MinimumNumberOfExecutedThings')
|
840
847
|
MissingContextValue = Shapes::StringShape.new(name: 'MissingContextValue')
|
@@ -855,6 +862,7 @@ module Aws::IoT
|
|
855
862
|
MqttContext = Shapes::StructureShape.new(name: 'MqttContext')
|
856
863
|
MqttHeaders = Shapes::StructureShape.new(name: 'MqttHeaders')
|
857
864
|
MqttPassword = Shapes::BlobShape.new(name: 'MqttPassword')
|
865
|
+
MqttTopic = Shapes::StringShape.new(name: 'MqttTopic')
|
858
866
|
MqttUsername = Shapes::StringShape.new(name: 'MqttUsername')
|
859
867
|
NamedShadowIndexingMode = Shapes::StringShape.new(name: 'NamedShadowIndexingMode')
|
860
868
|
NamedShadowNamesFilter = Shapes::ListShape.new(name: 'NamedShadowNamesFilter')
|
@@ -1666,6 +1674,7 @@ module Aws::IoT
|
|
1666
1674
|
Behavior.add_member(:metric_dimension, Shapes::ShapeRef.new(shape: MetricDimension, location_name: "metricDimension"))
|
1667
1675
|
Behavior.add_member(:criteria, Shapes::ShapeRef.new(shape: BehaviorCriteria, location_name: "criteria"))
|
1668
1676
|
Behavior.add_member(:suppress_alerts, Shapes::ShapeRef.new(shape: SuppressAlerts, location_name: "suppressAlerts"))
|
1677
|
+
Behavior.add_member(:export_metric, Shapes::ShapeRef.new(shape: ExportMetric, location_name: "exportMetric"))
|
1669
1678
|
Behavior.struct_class = Types::Behavior
|
1670
1679
|
|
1671
1680
|
BehaviorCriteria.add_member(:comparison_operator, Shapes::ShapeRef.new(shape: ComparisonOperator, location_name: "comparisonOperator"))
|
@@ -2165,6 +2174,7 @@ module Aws::IoT
|
|
2165
2174
|
CreateSecurityProfileRequest.add_member(:additional_metrics_to_retain, Shapes::ShapeRef.new(shape: AdditionalMetricsToRetainList, deprecated: true, location_name: "additionalMetricsToRetain", metadata: {"deprecatedMessage"=>"Use additionalMetricsToRetainV2."}))
|
2166
2175
|
CreateSecurityProfileRequest.add_member(:additional_metrics_to_retain_v2, Shapes::ShapeRef.new(shape: AdditionalMetricsToRetainV2List, location_name: "additionalMetricsToRetainV2"))
|
2167
2176
|
CreateSecurityProfileRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
|
2177
|
+
CreateSecurityProfileRequest.add_member(:metrics_export_config, Shapes::ShapeRef.new(shape: MetricsExportConfig, location_name: "metricsExportConfig"))
|
2168
2178
|
CreateSecurityProfileRequest.struct_class = Types::CreateSecurityProfileRequest
|
2169
2179
|
|
2170
2180
|
CreateSecurityProfileResponse.add_member(:security_profile_name, Shapes::ShapeRef.new(shape: SecurityProfileName, location_name: "securityProfileName"))
|
@@ -2695,6 +2705,7 @@ module Aws::IoT
|
|
2695
2705
|
DescribeSecurityProfileResponse.add_member(:version, Shapes::ShapeRef.new(shape: Version, location_name: "version"))
|
2696
2706
|
DescribeSecurityProfileResponse.add_member(:creation_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationDate"))
|
2697
2707
|
DescribeSecurityProfileResponse.add_member(:last_modified_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastModifiedDate"))
|
2708
|
+
DescribeSecurityProfileResponse.add_member(:metrics_export_config, Shapes::ShapeRef.new(shape: MetricsExportConfig, location_name: "metricsExportConfig"))
|
2698
2709
|
DescribeSecurityProfileResponse.struct_class = Types::DescribeSecurityProfileResponse
|
2699
2710
|
|
2700
2711
|
DescribeStreamRequest.add_member(:stream_id, Shapes::ShapeRef.new(shape: StreamId, required: true, location: "uri", location_name: "streamId"))
|
@@ -3288,8 +3299,15 @@ module Aws::IoT
|
|
3288
3299
|
KafkaAction.add_member(:key, Shapes::ShapeRef.new(shape: String, location_name: "key"))
|
3289
3300
|
KafkaAction.add_member(:partition, Shapes::ShapeRef.new(shape: String, location_name: "partition"))
|
3290
3301
|
KafkaAction.add_member(:client_properties, Shapes::ShapeRef.new(shape: ClientProperties, required: true, location_name: "clientProperties"))
|
3302
|
+
KafkaAction.add_member(:headers, Shapes::ShapeRef.new(shape: KafkaHeaders, location_name: "headers"))
|
3291
3303
|
KafkaAction.struct_class = Types::KafkaAction
|
3292
3304
|
|
3305
|
+
KafkaActionHeader.add_member(:key, Shapes::ShapeRef.new(shape: KafkaHeaderKey, required: true, location_name: "key"))
|
3306
|
+
KafkaActionHeader.add_member(:value, Shapes::ShapeRef.new(shape: KafkaHeaderValue, required: true, location_name: "value"))
|
3307
|
+
KafkaActionHeader.struct_class = Types::KafkaActionHeader
|
3308
|
+
|
3309
|
+
KafkaHeaders.member = Shapes::ShapeRef.new(shape: KafkaActionHeader)
|
3310
|
+
|
3293
3311
|
KeyPair.add_member(:public_key, Shapes::ShapeRef.new(shape: PublicKey, location_name: "PublicKey"))
|
3294
3312
|
KeyPair.add_member(:private_key, Shapes::ShapeRef.new(shape: PrivateKey, location_name: "PrivateKey"))
|
3295
3313
|
KeyPair.struct_class = Types::KeyPair
|
@@ -3946,6 +3964,7 @@ module Aws::IoT
|
|
3946
3964
|
|
3947
3965
|
MetricToRetain.add_member(:metric, Shapes::ShapeRef.new(shape: BehaviorMetric, required: true, location_name: "metric"))
|
3948
3966
|
MetricToRetain.add_member(:metric_dimension, Shapes::ShapeRef.new(shape: MetricDimension, location_name: "metricDimension"))
|
3967
|
+
MetricToRetain.add_member(:export_metric, Shapes::ShapeRef.new(shape: ExportMetric, location_name: "exportMetric"))
|
3949
3968
|
MetricToRetain.struct_class = Types::MetricToRetain
|
3950
3969
|
|
3951
3970
|
MetricValue.add_member(:count, Shapes::ShapeRef.new(shape: UnsignedLong, location_name: "count"))
|
@@ -3956,6 +3975,10 @@ module Aws::IoT
|
|
3956
3975
|
MetricValue.add_member(:strings, Shapes::ShapeRef.new(shape: StringList, location_name: "strings"))
|
3957
3976
|
MetricValue.struct_class = Types::MetricValue
|
3958
3977
|
|
3978
|
+
MetricsExportConfig.add_member(:mqtt_topic, Shapes::ShapeRef.new(shape: MqttTopic, required: true, location_name: "mqttTopic"))
|
3979
|
+
MetricsExportConfig.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
|
3980
|
+
MetricsExportConfig.struct_class = Types::MetricsExportConfig
|
3981
|
+
|
3959
3982
|
MissingContextValues.member = Shapes::ShapeRef.new(shape: MissingContextValue)
|
3960
3983
|
|
3961
3984
|
MitigationAction.add_member(:name, Shapes::ShapeRef.new(shape: MitigationActionName, location_name: "name"))
|
@@ -5026,6 +5049,8 @@ module Aws::IoT
|
|
5026
5049
|
UpdateSecurityProfileRequest.add_member(:delete_alert_targets, Shapes::ShapeRef.new(shape: DeleteAlertTargets, location_name: "deleteAlertTargets"))
|
5027
5050
|
UpdateSecurityProfileRequest.add_member(:delete_additional_metrics_to_retain, Shapes::ShapeRef.new(shape: DeleteAdditionalMetricsToRetain, location_name: "deleteAdditionalMetricsToRetain"))
|
5028
5051
|
UpdateSecurityProfileRequest.add_member(:expected_version, Shapes::ShapeRef.new(shape: OptionalVersion, location: "querystring", location_name: "expectedVersion"))
|
5052
|
+
UpdateSecurityProfileRequest.add_member(:metrics_export_config, Shapes::ShapeRef.new(shape: MetricsExportConfig, location_name: "metricsExportConfig"))
|
5053
|
+
UpdateSecurityProfileRequest.add_member(:delete_metrics_export_config, Shapes::ShapeRef.new(shape: DeleteMetricsExportConfig, location_name: "deleteMetricsExportConfig"))
|
5029
5054
|
UpdateSecurityProfileRequest.struct_class = Types::UpdateSecurityProfileRequest
|
5030
5055
|
|
5031
5056
|
UpdateSecurityProfileResponse.add_member(:security_profile_name, Shapes::ShapeRef.new(shape: SecurityProfileName, location_name: "securityProfileName"))
|
@@ -5038,6 +5063,7 @@ module Aws::IoT
|
|
5038
5063
|
UpdateSecurityProfileResponse.add_member(:version, Shapes::ShapeRef.new(shape: Version, location_name: "version"))
|
5039
5064
|
UpdateSecurityProfileResponse.add_member(:creation_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationDate"))
|
5040
5065
|
UpdateSecurityProfileResponse.add_member(:last_modified_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastModifiedDate"))
|
5066
|
+
UpdateSecurityProfileResponse.add_member(:metrics_export_config, Shapes::ShapeRef.new(shape: MetricsExportConfig, location_name: "metricsExportConfig"))
|
5041
5067
|
UpdateSecurityProfileResponse.struct_class = Types::UpdateSecurityProfileResponse
|
5042
5068
|
|
5043
5069
|
UpdateStreamRequest.add_member(:stream_id, Shapes::ShapeRef.new(shape: StreamId, required: true, location: "uri", location_name: "streamId"))
|
@@ -32,7 +32,7 @@ module Aws::IoT
|
|
32
32
|
raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
|
33
33
|
end
|
34
34
|
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
35
|
-
if Aws::Endpoints::Matchers.boolean_equals?(
|
35
|
+
if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
|
36
36
|
return Aws::Endpoints::Endpoint.new(url: "https://iot-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
37
37
|
end
|
38
38
|
raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
|
data/lib/aws-sdk-iot/types.rb
CHANGED
@@ -1288,18 +1288,30 @@ module Aws::IoT
|
|
1288
1288
|
# @!attribute [rw] criteria
|
1289
1289
|
# The criteria that determine if a device is behaving normally in
|
1290
1290
|
# regard to the `metric`.
|
1291
|
+
#
|
1292
|
+
# <note markdown="1"> In the IoT console, you can choose to be sent an alert through
|
1293
|
+
# Amazon SNS when IoT Device Defender detects that a device is
|
1294
|
+
# behaving anomalously.
|
1295
|
+
#
|
1296
|
+
# </note>
|
1291
1297
|
# @return [Types::BehaviorCriteria]
|
1292
1298
|
#
|
1293
1299
|
# @!attribute [rw] suppress_alerts
|
1294
1300
|
# Suppresses alerts.
|
1295
1301
|
# @return [Boolean]
|
1296
1302
|
#
|
1303
|
+
# @!attribute [rw] export_metric
|
1304
|
+
# Value indicates exporting metrics related to the behavior when it is
|
1305
|
+
# true.
|
1306
|
+
# @return [Boolean]
|
1307
|
+
#
|
1297
1308
|
class Behavior < Struct.new(
|
1298
1309
|
:name,
|
1299
1310
|
:metric,
|
1300
1311
|
:metric_dimension,
|
1301
1312
|
:criteria,
|
1302
|
-
:suppress_alerts
|
1313
|
+
:suppress_alerts,
|
1314
|
+
:export_metric)
|
1303
1315
|
SENSITIVE = []
|
1304
1316
|
include Aws::Structure
|
1305
1317
|
end
|
@@ -2879,20 +2891,18 @@ module Aws::IoT
|
|
2879
2891
|
# @return [String]
|
2880
2892
|
#
|
2881
2893
|
# @!attribute [rw] document_source
|
2882
|
-
# An S3 link to the job document
|
2883
|
-
# you don't specify a value
|
2894
|
+
# An S3 link, or S3 object URL, to the job document. The link is an
|
2895
|
+
# Amazon S3 object URL and is required if you don't specify a value
|
2896
|
+
# for `document`.
|
2884
2897
|
#
|
2885
|
-
#
|
2886
|
-
#
|
2898
|
+
# For example, `--document-source
|
2899
|
+
# https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0`
|
2887
2900
|
#
|
2888
|
-
#
|
2901
|
+
# For more information, see [Methods for accessing a bucket][1].
|
2889
2902
|
#
|
2890
|
-
# `$\{aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key\}`
|
2891
2903
|
#
|
2892
|
-
# where *bucket* is your bucket name and *key* is the object in the
|
2893
|
-
# bucket to which you are linking.
|
2894
2904
|
#
|
2895
|
-
#
|
2905
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html
|
2896
2906
|
# @return [String]
|
2897
2907
|
#
|
2898
2908
|
# @!attribute [rw] document
|
@@ -3127,8 +3137,8 @@ module Aws::IoT
|
|
3127
3137
|
# @return [String]
|
3128
3138
|
#
|
3129
3139
|
# @!attribute [rw] additional_parameters
|
3130
|
-
# A list of additional OTA update parameters which are name-value
|
3131
|
-
# pairs.
|
3140
|
+
# A list of additional OTA update parameters, which are name-value
|
3141
|
+
# pairs. They won't be sent to devices as a part of the Job document.
|
3132
3142
|
# @return [Hash<String,String>]
|
3133
3143
|
#
|
3134
3144
|
# @!attribute [rw] tags
|
@@ -3184,7 +3194,7 @@ module Aws::IoT
|
|
3184
3194
|
end
|
3185
3195
|
|
3186
3196
|
# @!attribute [rw] package_name
|
3187
|
-
# The name of the new package.
|
3197
|
+
# The name of the new software package.
|
3188
3198
|
# @return [String]
|
3189
3199
|
#
|
3190
3200
|
# @!attribute [rw] description
|
@@ -3215,7 +3225,7 @@ module Aws::IoT
|
|
3215
3225
|
end
|
3216
3226
|
|
3217
3227
|
# @!attribute [rw] package_name
|
3218
|
-
# The name of the package.
|
3228
|
+
# The name of the software package.
|
3219
3229
|
# @return [String]
|
3220
3230
|
#
|
3221
3231
|
# @!attribute [rw] package_arn
|
@@ -3235,7 +3245,7 @@ module Aws::IoT
|
|
3235
3245
|
end
|
3236
3246
|
|
3237
3247
|
# @!attribute [rw] package_name
|
3238
|
-
# The name of the associated package.
|
3248
|
+
# The name of the associated software package.
|
3239
3249
|
# @return [String]
|
3240
3250
|
#
|
3241
3251
|
# @!attribute [rw] version_name
|
@@ -3285,7 +3295,7 @@ module Aws::IoT
|
|
3285
3295
|
# @return [String]
|
3286
3296
|
#
|
3287
3297
|
# @!attribute [rw] package_name
|
3288
|
-
# The name of the associated package.
|
3298
|
+
# The name of the associated software package.
|
3289
3299
|
# @return [String]
|
3290
3300
|
#
|
3291
3301
|
# @!attribute [rw] version_name
|
@@ -3769,6 +3779,10 @@ module Aws::IoT
|
|
3769
3779
|
# Metadata that can be used to manage the security profile.
|
3770
3780
|
# @return [Array<Types::Tag>]
|
3771
3781
|
#
|
3782
|
+
# @!attribute [rw] metrics_export_config
|
3783
|
+
# Specifies the MQTT topic and role ARN required for metric export.
|
3784
|
+
# @return [Types::MetricsExportConfig]
|
3785
|
+
#
|
3772
3786
|
class CreateSecurityProfileRequest < Struct.new(
|
3773
3787
|
:security_profile_name,
|
3774
3788
|
:security_profile_description,
|
@@ -3776,7 +3790,8 @@ module Aws::IoT
|
|
3776
3790
|
:alert_targets,
|
3777
3791
|
:additional_metrics_to_retain,
|
3778
3792
|
:additional_metrics_to_retain_v2,
|
3779
|
-
:tags
|
3793
|
+
:tags,
|
3794
|
+
:metrics_export_config)
|
3780
3795
|
SENSITIVE = []
|
3781
3796
|
include Aws::Structure
|
3782
3797
|
end
|
@@ -4423,7 +4438,7 @@ module Aws::IoT
|
|
4423
4438
|
class DeleteOTAUpdateResponse < Aws::EmptyStructure; end
|
4424
4439
|
|
4425
4440
|
# @!attribute [rw] package_name
|
4426
|
-
# The name of the target package.
|
4441
|
+
# The name of the target software package.
|
4427
4442
|
# @return [String]
|
4428
4443
|
#
|
4429
4444
|
# @!attribute [rw] client_token
|
@@ -4445,7 +4460,7 @@ module Aws::IoT
|
|
4445
4460
|
class DeletePackageResponse < Aws::EmptyStructure; end
|
4446
4461
|
|
4447
4462
|
# @!attribute [rw] package_name
|
4448
|
-
# The name of the associated package.
|
4463
|
+
# The name of the associated software package.
|
4449
4464
|
# @return [String]
|
4450
4465
|
#
|
4451
4466
|
# @!attribute [rw] version_name
|
@@ -5287,7 +5302,8 @@ module Aws::IoT
|
|
5287
5302
|
#
|
5288
5303
|
# We strongly recommend that customers use the newer `iot:Data-ATS`
|
5289
5304
|
# endpoint type to avoid issues related to the widespread distrust of
|
5290
|
-
# Symantec certificate authorities.
|
5305
|
+
# Symantec certificate authorities. ATS Signed Certificates are more
|
5306
|
+
# secure and are trusted by most popular browsers.
|
5291
5307
|
# @return [String]
|
5292
5308
|
#
|
5293
5309
|
class DescribeEndpointRequest < Struct.new(
|
@@ -5994,6 +6010,10 @@ module Aws::IoT
|
|
5994
6010
|
# The time the security profile was last modified.
|
5995
6011
|
# @return [Time]
|
5996
6012
|
#
|
6013
|
+
# @!attribute [rw] metrics_export_config
|
6014
|
+
# Specifies the MQTT topic and role ARN required for metric export.
|
6015
|
+
# @return [Types::MetricsExportConfig]
|
6016
|
+
#
|
5997
6017
|
class DescribeSecurityProfileResponse < Struct.new(
|
5998
6018
|
:security_profile_name,
|
5999
6019
|
:security_profile_arn,
|
@@ -6004,7 +6024,8 @@ module Aws::IoT
|
|
6004
6024
|
:additional_metrics_to_retain_v2,
|
6005
6025
|
:version,
|
6006
6026
|
:creation_date,
|
6007
|
-
:last_modified_date
|
6027
|
+
:last_modified_date,
|
6028
|
+
:metrics_export_config)
|
6008
6029
|
SENSITIVE = []
|
6009
6030
|
include Aws::Structure
|
6010
6031
|
end
|
@@ -7232,7 +7253,7 @@ module Aws::IoT
|
|
7232
7253
|
end
|
7233
7254
|
|
7234
7255
|
# @!attribute [rw] package_name
|
7235
|
-
# The name of the target package.
|
7256
|
+
# The name of the target software package.
|
7236
7257
|
# @return [String]
|
7237
7258
|
#
|
7238
7259
|
class GetPackageRequest < Struct.new(
|
@@ -7242,7 +7263,7 @@ module Aws::IoT
|
|
7242
7263
|
end
|
7243
7264
|
|
7244
7265
|
# @!attribute [rw] package_name
|
7245
|
-
# The name of the package.
|
7266
|
+
# The name of the software package.
|
7246
7267
|
# @return [String]
|
7247
7268
|
#
|
7248
7269
|
# @!attribute [rw] package_arn
|
@@ -7296,7 +7317,7 @@ module Aws::IoT
|
|
7296
7317
|
# @return [String]
|
7297
7318
|
#
|
7298
7319
|
# @!attribute [rw] package_name
|
7299
|
-
# The name of the package.
|
7320
|
+
# The name of the software package.
|
7300
7321
|
# @return [String]
|
7301
7322
|
#
|
7302
7323
|
# @!attribute [rw] version_name
|
@@ -8612,12 +8633,44 @@ module Aws::IoT
|
|
8612
8633
|
# Properties of the Apache Kafka producer client.
|
8613
8634
|
# @return [Hash<String,String>]
|
8614
8635
|
#
|
8636
|
+
# @!attribute [rw] headers
|
8637
|
+
# The list of Kafka headers that you specify.
|
8638
|
+
# @return [Array<Types::KafkaActionHeader>]
|
8639
|
+
#
|
8615
8640
|
class KafkaAction < Struct.new(
|
8616
8641
|
:destination_arn,
|
8617
8642
|
:topic,
|
8618
8643
|
:key,
|
8619
8644
|
:partition,
|
8620
|
-
:client_properties
|
8645
|
+
:client_properties,
|
8646
|
+
:headers)
|
8647
|
+
SENSITIVE = []
|
8648
|
+
include Aws::Structure
|
8649
|
+
end
|
8650
|
+
|
8651
|
+
# Specifies a Kafka header using key-value pairs when you create a
|
8652
|
+
# Rule’s Kafka Action. You can use these headers to route data from IoT
|
8653
|
+
# clients to downstream Kafka clusters without modifying your message
|
8654
|
+
# payload.
|
8655
|
+
#
|
8656
|
+
# For more information about Rule's Kafka action, see [Apache
|
8657
|
+
# Kafka][1].
|
8658
|
+
#
|
8659
|
+
#
|
8660
|
+
#
|
8661
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/apache-kafka-rule-action.html
|
8662
|
+
#
|
8663
|
+
# @!attribute [rw] key
|
8664
|
+
# The key of the Kafka header.
|
8665
|
+
# @return [String]
|
8666
|
+
#
|
8667
|
+
# @!attribute [rw] value
|
8668
|
+
# The value of the Kafka header.
|
8669
|
+
# @return [String]
|
8670
|
+
#
|
8671
|
+
class KafkaActionHeader < Struct.new(
|
8672
|
+
:key,
|
8673
|
+
:value)
|
8621
8674
|
SENSITIVE = []
|
8622
8675
|
include Aws::Structure
|
8623
8676
|
end
|
@@ -9996,7 +10049,7 @@ module Aws::IoT
|
|
9996
10049
|
end
|
9997
10050
|
|
9998
10051
|
# @!attribute [rw] package_name
|
9999
|
-
# The name of the target package.
|
10052
|
+
# The name of the target software package.
|
10000
10053
|
# @return [String]
|
10001
10054
|
#
|
10002
10055
|
# @!attribute [rw] status
|
@@ -11500,9 +11553,16 @@ module Aws::IoT
|
|
11500
11553
|
# The dimension of a metric. This can't be used with custom metrics.
|
11501
11554
|
# @return [Types::MetricDimension]
|
11502
11555
|
#
|
11556
|
+
# @!attribute [rw] export_metric
|
11557
|
+
# Value added in both Behavior and AdditionalMetricsToRetainV2 to
|
11558
|
+
# indicate if Device Defender Detect should export the corresponding
|
11559
|
+
# metrics.
|
11560
|
+
# @return [Boolean]
|
11561
|
+
#
|
11503
11562
|
class MetricToRetain < Struct.new(
|
11504
11563
|
:metric,
|
11505
|
-
:metric_dimension
|
11564
|
+
:metric_dimension,
|
11565
|
+
:export_metric)
|
11506
11566
|
SENSITIVE = []
|
11507
11567
|
include Aws::Structure
|
11508
11568
|
end
|
@@ -11547,6 +11607,26 @@ module Aws::IoT
|
|
11547
11607
|
include Aws::Structure
|
11548
11608
|
end
|
11549
11609
|
|
11610
|
+
# Set configurations for metrics export.
|
11611
|
+
#
|
11612
|
+
# @!attribute [rw] mqtt_topic
|
11613
|
+
# The MQTT topic that Device Defender Detect should publish messages
|
11614
|
+
# to for metrics export.
|
11615
|
+
# @return [String]
|
11616
|
+
#
|
11617
|
+
# @!attribute [rw] role_arn
|
11618
|
+
# This role ARN has permission to publish MQTT messages, after which
|
11619
|
+
# Device Defender Detect can assume the role and publish messages on
|
11620
|
+
# your behalf.
|
11621
|
+
# @return [String]
|
11622
|
+
#
|
11623
|
+
class MetricsExportConfig < Struct.new(
|
11624
|
+
:mqtt_topic,
|
11625
|
+
:role_arn)
|
11626
|
+
SENSITIVE = []
|
11627
|
+
include Aws::Structure
|
11628
|
+
end
|
11629
|
+
|
11550
11630
|
# Describes which changes should be applied as part of a mitigation
|
11551
11631
|
# action.
|
11552
11632
|
#
|
@@ -11836,7 +11916,8 @@ module Aws::IoT
|
|
11836
11916
|
# @return [Types::CodeSigning]
|
11837
11917
|
#
|
11838
11918
|
# @!attribute [rw] attributes
|
11839
|
-
# A list of name
|
11919
|
+
# A list of name-attribute pairs. They won't be sent to devices as a
|
11920
|
+
# part of the Job document.
|
11840
11921
|
# @return [Hash<String,String>]
|
11841
11922
|
#
|
11842
11923
|
class OTAUpdateFile < Struct.new(
|
@@ -12041,7 +12122,7 @@ module Aws::IoT
|
|
12041
12122
|
# A summary of information about a software package.
|
12042
12123
|
#
|
12043
12124
|
# @!attribute [rw] package_name
|
12044
|
-
# The name for the target package.
|
12125
|
+
# The name for the target software package.
|
12045
12126
|
# @return [String]
|
12046
12127
|
#
|
12047
12128
|
# @!attribute [rw] default_version_name
|
@@ -13133,6 +13214,13 @@ module Aws::IoT
|
|
13133
13214
|
# to a year in advance and must be scheduled a minimum of thirty
|
13134
13215
|
# minutes from the current time. The date and time format for the
|
13135
13216
|
# `startTime` is YYYY-MM-DD for the date and HH:MM for the time.
|
13217
|
+
#
|
13218
|
+
# For more information on the syntax for `startTime` when using an API
|
13219
|
+
# command or the Command Line Interface, see [Timestamp][1].
|
13220
|
+
#
|
13221
|
+
#
|
13222
|
+
#
|
13223
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp
|
13136
13224
|
# @return [String]
|
13137
13225
|
#
|
13138
13226
|
# @!attribute [rw] end_time
|
@@ -13144,6 +13232,13 @@ module Aws::IoT
|
|
13144
13232
|
# maximum duration between `startTime` and `endTime` is two years. The
|
13145
13233
|
# date and time format for the `endTime` is YYYY-MM-DD for the date
|
13146
13234
|
# and HH:MM for the time.
|
13235
|
+
#
|
13236
|
+
# For more information on the syntax for `endTime` when using an API
|
13237
|
+
# command or the Command Line Interface, see [Timestamp][1].
|
13238
|
+
#
|
13239
|
+
#
|
13240
|
+
#
|
13241
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp
|
13147
13242
|
# @return [String]
|
13148
13243
|
#
|
13149
13244
|
# @!attribute [rw] end_behavior
|
@@ -13187,7 +13282,8 @@ module Aws::IoT
|
|
13187
13282
|
# @return [String]
|
13188
13283
|
#
|
13189
13284
|
# @!attribute [rw] max_results
|
13190
|
-
# The maximum number of results to return at one time.
|
13285
|
+
# The maximum number of results to return at one time. The response
|
13286
|
+
# might contain fewer results but will never contain more.
|
13191
13287
|
# @return [Integer]
|
13192
13288
|
#
|
13193
13289
|
# @!attribute [rw] query_version
|
@@ -14362,6 +14458,11 @@ module Aws::IoT
|
|
14362
14458
|
# information, see [Managed fields][1] in the *Amazon Web Services IoT
|
14363
14459
|
# Core Developer Guide*.
|
14364
14460
|
#
|
14461
|
+
# <note markdown="1"> You can't modify managed fields by updating fleet indexing
|
14462
|
+
# configuration.
|
14463
|
+
#
|
14464
|
+
# </note>
|
14465
|
+
#
|
14365
14466
|
#
|
14366
14467
|
#
|
14367
14468
|
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field
|
@@ -14485,7 +14586,18 @@ module Aws::IoT
|
|
14485
14586
|
#
|
14486
14587
|
# @!attribute [rw] managed_fields
|
14487
14588
|
# Contains fields that are indexed and whose types are already known
|
14488
|
-
# by the Fleet Indexing service.
|
14589
|
+
# by the Fleet Indexing service. This is an optional field. For more
|
14590
|
+
# information, see [Managed fields][1] in the *Amazon Web Services IoT
|
14591
|
+
# Core Developer Guide*.
|
14592
|
+
#
|
14593
|
+
# <note markdown="1"> You can't modify managed fields by updating fleet indexing
|
14594
|
+
# configuration.
|
14595
|
+
#
|
14596
|
+
# </note>
|
14597
|
+
#
|
14598
|
+
#
|
14599
|
+
#
|
14600
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field
|
14489
14601
|
# @return [Array<Types::Field>]
|
14490
14602
|
#
|
14491
14603
|
# @!attribute [rw] custom_fields
|
@@ -15824,7 +15936,7 @@ module Aws::IoT
|
|
15824
15936
|
class UpdatePackageConfigurationResponse < Aws::EmptyStructure; end
|
15825
15937
|
|
15826
15938
|
# @!attribute [rw] package_name
|
15827
|
-
# The name of the target package.
|
15939
|
+
# The name of the target software package.
|
15828
15940
|
# @return [String]
|
15829
15941
|
#
|
15830
15942
|
# @!attribute [rw] description
|
@@ -15882,8 +15994,8 @@ module Aws::IoT
|
|
15882
15994
|
#
|
15883
15995
|
# @!attribute [rw] attributes
|
15884
15996
|
# Metadata that can be used to define a package version’s
|
15885
|
-
# configuration. For example, the S3 file location,
|
15886
|
-
# options that are being sent to the device or fleet.
|
15997
|
+
# configuration. For example, the Amazon S3 file location,
|
15998
|
+
# configuration options that are being sent to the device or fleet.
|
15887
15999
|
#
|
15888
16000
|
# **Note:** Attributes can be updated only when the package version is
|
15889
16001
|
# in a draft state.
|
@@ -16123,6 +16235,15 @@ module Aws::IoT
|
|
16123
16235
|
# `VersionConflictException` is thrown.
|
16124
16236
|
# @return [Integer]
|
16125
16237
|
#
|
16238
|
+
# @!attribute [rw] metrics_export_config
|
16239
|
+
# Specifies the MQTT topic and role ARN required for metric export.
|
16240
|
+
# @return [Types::MetricsExportConfig]
|
16241
|
+
#
|
16242
|
+
# @!attribute [rw] delete_metrics_export_config
|
16243
|
+
# Set the value as true to delete metrics export related
|
16244
|
+
# configurations.
|
16245
|
+
# @return [Boolean]
|
16246
|
+
#
|
16126
16247
|
class UpdateSecurityProfileRequest < Struct.new(
|
16127
16248
|
:security_profile_name,
|
16128
16249
|
:security_profile_description,
|
@@ -16133,7 +16254,9 @@ module Aws::IoT
|
|
16133
16254
|
:delete_behaviors,
|
16134
16255
|
:delete_alert_targets,
|
16135
16256
|
:delete_additional_metrics_to_retain,
|
16136
|
-
:expected_version
|
16257
|
+
:expected_version,
|
16258
|
+
:metrics_export_config,
|
16259
|
+
:delete_metrics_export_config)
|
16137
16260
|
SENSITIVE = []
|
16138
16261
|
include Aws::Structure
|
16139
16262
|
end
|
@@ -16187,6 +16310,10 @@ module Aws::IoT
|
|
16187
16310
|
# The time the security profile was last modified.
|
16188
16311
|
# @return [Time]
|
16189
16312
|
#
|
16313
|
+
# @!attribute [rw] metrics_export_config
|
16314
|
+
# Specifies the MQTT topic and role ARN required for metric export.
|
16315
|
+
# @return [Types::MetricsExportConfig]
|
16316
|
+
#
|
16190
16317
|
class UpdateSecurityProfileResponse < Struct.new(
|
16191
16318
|
:security_profile_name,
|
16192
16319
|
:security_profile_arn,
|
@@ -16197,7 +16324,8 @@ module Aws::IoT
|
|
16197
16324
|
:additional_metrics_to_retain_v2,
|
16198
16325
|
:version,
|
16199
16326
|
:creation_date,
|
16200
|
-
:last_modified_date
|
16327
|
+
:last_modified_date,
|
16328
|
+
:metrics_export_config)
|
16201
16329
|
SENSITIVE = []
|
16202
16330
|
include Aws::Structure
|
16203
16331
|
end
|
data/lib/aws-sdk-iot.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-iot
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.112.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-11-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.184.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.184.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|