aws-sdk-iot 1.80.0 → 1.111.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 +158 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-iot/client.rb +1464 -197
- data/lib/aws-sdk-iot/client_api.rb +584 -3
- data/lib/aws-sdk-iot/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-iot/endpoint_provider.rb +63 -0
- data/lib/aws-sdk-iot/endpoints.rb +3516 -0
- data/lib/aws-sdk-iot/errors.rb +37 -0
- data/lib/aws-sdk-iot/plugins/endpoints.rb +568 -0
- data/lib/aws-sdk-iot/types.rb +1752 -5345
- data/lib/aws-sdk-iot.rb +5 -1
- metadata +8 -4
data/lib/aws-sdk-iot/client.rb
CHANGED
@@ -27,7 +27,11 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
-
require 'aws-sdk-core/plugins/
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/request_compression.rb'
|
32
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
33
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
34
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
31
35
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
36
|
|
33
37
|
Aws::Plugins::GlobalConfiguration.add_identifier(:iot)
|
@@ -73,8 +77,13 @@ module Aws::IoT
|
|
73
77
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
78
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
79
|
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
-
add_plugin(Aws::Plugins::
|
80
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
81
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
82
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
83
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
84
|
+
add_plugin(Aws::Plugins::Sign)
|
77
85
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
86
|
+
add_plugin(Aws::IoT::Plugins::Endpoints)
|
78
87
|
|
79
88
|
# @overload initialize(options)
|
80
89
|
# @param [Hash] options
|
@@ -175,10 +184,18 @@ module Aws::IoT
|
|
175
184
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
176
185
|
# a clock skew correction and retry requests with skewed client clocks.
|
177
186
|
#
|
187
|
+
# @option options [String] :defaults_mode ("legacy")
|
188
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
189
|
+
# accepted modes and the configuration defaults that are included.
|
190
|
+
#
|
178
191
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
179
192
|
# Set to true to disable SDK automatically adding host prefix
|
180
193
|
# to default service endpoint when available.
|
181
194
|
#
|
195
|
+
# @option options [Boolean] :disable_request_compression (false)
|
196
|
+
# When set to 'true' the request body will not be compressed
|
197
|
+
# for supported operations.
|
198
|
+
#
|
182
199
|
# @option options [String] :endpoint
|
183
200
|
# The client endpoint is normally constructed from the `:region`
|
184
201
|
# option. You should only configure an `:endpoint` when connecting
|
@@ -199,6 +216,10 @@ module Aws::IoT
|
|
199
216
|
# @option options [Boolean] :endpoint_discovery (false)
|
200
217
|
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
201
218
|
#
|
219
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
220
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
221
|
+
# variables and the shared configuration file.
|
222
|
+
#
|
202
223
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
203
224
|
# The log formatter.
|
204
225
|
#
|
@@ -219,6 +240,11 @@ module Aws::IoT
|
|
219
240
|
# Used when loading credentials from the shared credentials file
|
220
241
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
221
242
|
#
|
243
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
244
|
+
# The minimum size in bytes that triggers compression for request
|
245
|
+
# bodies. The value must be non-negative integer value between 0
|
246
|
+
# and 10485780 bytes inclusive.
|
247
|
+
#
|
222
248
|
# @option options [Proc] :retry_backoff
|
223
249
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
224
250
|
# This option is only used in the `legacy` retry mode.
|
@@ -264,6 +290,11 @@ module Aws::IoT
|
|
264
290
|
# in the future.
|
265
291
|
#
|
266
292
|
#
|
293
|
+
# @option options [String] :sdk_ua_app_id
|
294
|
+
# A unique and opaque application ID that is appended to the
|
295
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
296
|
+
# maximum length of 50.
|
297
|
+
#
|
267
298
|
# @option options [String] :secret_access_key
|
268
299
|
#
|
269
300
|
# @option options [String] :session_token
|
@@ -277,6 +308,19 @@ module Aws::IoT
|
|
277
308
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
278
309
|
# requests are made, and retries are disabled.
|
279
310
|
#
|
311
|
+
# @option options [Aws::TokenProvider] :token_provider
|
312
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
313
|
+
# following classes:
|
314
|
+
#
|
315
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
316
|
+
# tokens.
|
317
|
+
#
|
318
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
319
|
+
# access token generated from `aws login`.
|
320
|
+
#
|
321
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
322
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
323
|
+
#
|
280
324
|
# @option options [Boolean] :use_dualstack_endpoint
|
281
325
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
282
326
|
# will be used if available.
|
@@ -290,6 +334,9 @@ module Aws::IoT
|
|
290
334
|
# When `true`, request parameters are validated before
|
291
335
|
# sending the request.
|
292
336
|
#
|
337
|
+
# @option options [Aws::IoT::EndpointProvider] :endpoint_provider
|
338
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::IoT::EndpointParameters`
|
339
|
+
#
|
293
340
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
294
341
|
# requests through. Formatted like 'http://proxy.com:123'.
|
295
342
|
#
|
@@ -297,7 +344,7 @@ module Aws::IoT
|
|
297
344
|
# seconds to wait when opening a HTTP session before raising a
|
298
345
|
# `Timeout::Error`.
|
299
346
|
#
|
300
|
-
# @option options [
|
347
|
+
# @option options [Float] :http_read_timeout (60) The default
|
301
348
|
# number of seconds to wait for response data. This value can
|
302
349
|
# safely be set per-request on the session.
|
303
350
|
#
|
@@ -313,6 +360,9 @@ module Aws::IoT
|
|
313
360
|
# disables this behaviour. This value can safely be set per
|
314
361
|
# request on the session.
|
315
362
|
#
|
363
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
364
|
+
# in seconds.
|
365
|
+
#
|
316
366
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
317
367
|
# HTTP debug output will be sent to the `:logger`.
|
318
368
|
#
|
@@ -569,7 +619,9 @@ module Aws::IoT
|
|
569
619
|
# Attaches the specified policy to the specified principal (certificate
|
570
620
|
# or other credential).
|
571
621
|
#
|
572
|
-
# **Note:** This action is deprecated
|
622
|
+
# **Note:** This action is deprecated and works as expected for backward
|
623
|
+
# compatibility, but we won't add enhancements. Use AttachPolicy
|
624
|
+
# instead.
|
573
625
|
#
|
574
626
|
# Requires permission to access the [AttachPrincipalPolicy][1] action.
|
575
627
|
#
|
@@ -634,8 +686,8 @@ module Aws::IoT
|
|
634
686
|
end
|
635
687
|
|
636
688
|
# Attaches the specified principal to the specified thing. A principal
|
637
|
-
# can be X.509 certificates,
|
638
|
-
#
|
689
|
+
# can be X.509 certificates, Amazon Cognito identities or federated
|
690
|
+
# identities.
|
639
691
|
#
|
640
692
|
# Requires permission to access the [AttachThingPrincipal][1] action.
|
641
693
|
#
|
@@ -1006,6 +1058,12 @@ module Aws::IoT
|
|
1006
1058
|
# account: "AwsAccountId",
|
1007
1059
|
# iam_role_arn: "RoleArn",
|
1008
1060
|
# role_alias_arn: "RoleAliasArn",
|
1061
|
+
# issuer_certificate_identifier: {
|
1062
|
+
# issuer_certificate_subject: "IssuerCertificateSubject",
|
1063
|
+
# issuer_id: "IssuerId",
|
1064
|
+
# issuer_certificate_serial_number: "IssuerCertificateSerialNumber",
|
1065
|
+
# },
|
1066
|
+
# device_certificate_arn: "CertificateArn",
|
1009
1067
|
# },
|
1010
1068
|
# expiration_date: Time.now,
|
1011
1069
|
# suppress_indefinitely: false,
|
@@ -1063,6 +1121,15 @@ module Aws::IoT
|
|
1063
1121
|
# Specifies whether IoT validates the token signature in an
|
1064
1122
|
# authorization request.
|
1065
1123
|
#
|
1124
|
+
# @option params [Boolean] :enable_caching_for_http
|
1125
|
+
# When `true`, the result from the authorizer’s Lambda function is
|
1126
|
+
# cached for clients that use persistent HTTP connections. The results
|
1127
|
+
# are cached for the time specified by the Lambda function in
|
1128
|
+
# `refreshAfterInSeconds`. This value does not affect authorization of
|
1129
|
+
# clients that use MQTT connections.
|
1130
|
+
#
|
1131
|
+
# The default value is `false`.
|
1132
|
+
#
|
1066
1133
|
# @return [Types::CreateAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1067
1134
|
#
|
1068
1135
|
# * {Types::CreateAuthorizerResponse#authorizer_name #authorizer_name} => String
|
@@ -1085,6 +1152,7 @@ module Aws::IoT
|
|
1085
1152
|
# },
|
1086
1153
|
# ],
|
1087
1154
|
# signing_disabled: false,
|
1155
|
+
# enable_caching_for_http: false,
|
1088
1156
|
# })
|
1089
1157
|
#
|
1090
1158
|
# @example Response structure
|
@@ -1153,61 +1221,63 @@ module Aws::IoT
|
|
1153
1221
|
# Creates an X.509 certificate using the specified certificate signing
|
1154
1222
|
# request.
|
1155
1223
|
#
|
1156
|
-
#
|
1157
|
-
#
|
1158
|
-
#
|
1159
|
-
#
|
1224
|
+
# Requires permission to access the [CreateCertificateFromCsr][1]
|
1225
|
+
# action.
|
1226
|
+
#
|
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, NIST
|
1229
|
+
# P-384, or NIST P-521 curves. For supported certificates, consult [
|
1230
|
+
# Certificate signing algorithms supported by IoT][2].
|
1231
|
+
#
|
1232
|
+
# </note>
|
1160
1233
|
#
|
1161
|
-
#
|
1162
|
-
#
|
1234
|
+
# <note markdown="1"> Reusing the same certificate signing request (CSR) results in a
|
1235
|
+
# distinct certificate.
|
1163
1236
|
#
|
1164
|
-
#
|
1165
|
-
# action.
|
1237
|
+
# </note>
|
1166
1238
|
#
|
1167
1239
|
# You can create multiple certificates in a batch by creating a
|
1168
|
-
# directory, copying multiple
|
1240
|
+
# directory, copying multiple `.csr` files into that directory, and then
|
1169
1241
|
# specifying that directory on the command line. The following commands
|
1170
|
-
# show how to create a batch of certificates given a batch of CSRs.
|
1171
|
-
#
|
1172
|
-
#
|
1173
|
-
# my-csr-directory:
|
1242
|
+
# show how to create a batch of certificates given a batch of CSRs. In
|
1243
|
+
# the following commands, we assume that a set of CSRs are located
|
1244
|
+
# inside of the directory my-csr-directory:
|
1174
1245
|
#
|
1175
1246
|
# On Linux and OS X, the command is:
|
1176
1247
|
#
|
1177
|
-
#
|
1248
|
+
# `$ ls my-csr-directory/ | xargs -I \{\} aws iot
|
1178
1249
|
# create-certificate-from-csr --certificate-signing-request
|
1179
|
-
# file://my-csr-directory
|
1250
|
+
# file://my-csr-directory/\{\}`
|
1180
1251
|
#
|
1181
1252
|
# This command lists all of the CSRs in my-csr-directory and pipes each
|
1182
|
-
# CSR file name to the aws iot create-certificate-from-csr Amazon Web
|
1253
|
+
# CSR file name to the `aws iot create-certificate-from-csr` Amazon Web
|
1183
1254
|
# Services CLI command to create a certificate for the corresponding
|
1184
1255
|
# CSR.
|
1185
1256
|
#
|
1186
|
-
#
|
1187
|
-
#
|
1257
|
+
# You can also run the `aws iot create-certificate-from-csr` part of the
|
1258
|
+
# command in parallel to speed up the certificate creation process:
|
1188
1259
|
#
|
1189
|
-
#
|
1260
|
+
# `$ ls my-csr-directory/ | xargs -P 10 -I \{\} aws iot
|
1190
1261
|
# create-certificate-from-csr --certificate-signing-request
|
1191
|
-
# file://my-csr-directory
|
1262
|
+
# file://my-csr-directory/\{\} `
|
1192
1263
|
#
|
1193
1264
|
# On Windows PowerShell, the command to create certificates for all CSRs
|
1194
1265
|
# in my-csr-directory is:
|
1195
1266
|
#
|
1196
|
-
#
|
1197
|
-
#
|
1198
|
-
# file://my-csr-directory/$\_\\}
|
1267
|
+
# `> ls -Name my-csr-directory | %\{aws iot create-certificate-from-csr
|
1268
|
+
# --certificate-signing-request file://my-csr-directory/$_\} `
|
1199
1269
|
#
|
1200
1270
|
# On a Windows command prompt, the command to create certificates for
|
1201
1271
|
# all CSRs in my-csr-directory is:
|
1202
1272
|
#
|
1203
|
-
#
|
1273
|
+
# `> forfiles /p my-csr-directory /c "cmd /c aws iot
|
1204
1274
|
# create-certificate-from-csr --certificate-signing-request
|
1205
|
-
# file://@path"
|
1275
|
+
# file://@path" `
|
1206
1276
|
#
|
1207
1277
|
#
|
1208
1278
|
#
|
1209
|
-
# [1]: https://docs.aws.amazon.com/
|
1210
|
-
# [2]: https://docs.aws.amazon.com/
|
1279
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1280
|
+
# [2]: https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html#x509-cert-algorithms
|
1211
1281
|
#
|
1212
1282
|
# @option params [required, String] :certificate_signing_request
|
1213
1283
|
# The certificate signing request (CSR).
|
@@ -1252,17 +1322,21 @@ module Aws::IoT
|
|
1252
1322
|
#
|
1253
1323
|
# @option params [required, String] :metric_name
|
1254
1324
|
# The name of the custom metric. This will be used in the metric report
|
1255
|
-
# submitted from the device/thing.
|
1256
|
-
#
|
1325
|
+
# submitted from the device/thing. The name can't begin with `aws:`.
|
1326
|
+
# You can't change the name after you define it.
|
1257
1327
|
#
|
1258
1328
|
# @option params [String] :display_name
|
1259
|
-
#
|
1260
|
-
#
|
1261
|
-
# identifier in the device metric report.
|
1329
|
+
# The friendly name in the console for the custom metric. This name
|
1330
|
+
# doesn't have to be unique. Don't use this name as the metric
|
1331
|
+
# identifier in the device metric report. You can update the friendly
|
1332
|
+
# name after you define it.
|
1262
1333
|
#
|
1263
1334
|
# @option params [required, String] :metric_type
|
1264
|
-
# The type of the custom metric.
|
1265
|
-
#
|
1335
|
+
# The type of the custom metric.
|
1336
|
+
#
|
1337
|
+
# The type `number` only takes a single metric value as an input, but
|
1338
|
+
# when you submit the metrics value in the DeviceMetrics report, you
|
1339
|
+
# must pass it as an array with a single value.
|
1266
1340
|
#
|
1267
1341
|
# @option params [Array<Types::Tag>] :tags
|
1268
1342
|
# Metadata that can be used to manage the custom metric.
|
@@ -1428,6 +1502,9 @@ module Aws::IoT
|
|
1428
1502
|
#
|
1429
1503
|
# </note>
|
1430
1504
|
#
|
1505
|
+
# @option params [Types::TlsConfig] :tls_config
|
1506
|
+
# An object that specifies the TLS configuration for a domain.
|
1507
|
+
#
|
1431
1508
|
# @return [Types::CreateDomainConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1432
1509
|
#
|
1433
1510
|
# * {Types::CreateDomainConfigurationResponse#domain_configuration_name #domain_configuration_name} => String
|
@@ -1451,6 +1528,9 @@ module Aws::IoT
|
|
1451
1528
|
# value: "TagValue",
|
1452
1529
|
# },
|
1453
1530
|
# ],
|
1531
|
+
# tls_config: {
|
1532
|
+
# security_policy: "SecurityPolicy",
|
1533
|
+
# },
|
1454
1534
|
# })
|
1455
1535
|
#
|
1456
1536
|
# @example Response structure
|
@@ -1594,7 +1674,7 @@ module Aws::IoT
|
|
1594
1674
|
#
|
1595
1675
|
#
|
1596
1676
|
#
|
1597
|
-
# [1]: https://docs.aws.amazon.com/
|
1677
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
|
1598
1678
|
#
|
1599
1679
|
# @option params [Array<Types::Tag>] :tags
|
1600
1680
|
# Metadata, which can be used to manage the fleet metric.
|
@@ -1656,20 +1736,18 @@ module Aws::IoT
|
|
1656
1736
|
# A list of things and thing groups to which the job should be sent.
|
1657
1737
|
#
|
1658
1738
|
# @option params [String] :document_source
|
1659
|
-
# An S3 link to the job document.
|
1660
|
-
# for
|
1739
|
+
# An S3 link, or S3 object URL, to the job document. The link is an
|
1740
|
+
# Amazon S3 object URL and is required if you don't specify a value for
|
1741
|
+
# `document`.
|
1661
1742
|
#
|
1662
|
-
#
|
1663
|
-
#
|
1743
|
+
# For example, `--document-source
|
1744
|
+
# https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0`
|
1664
1745
|
#
|
1665
|
-
#
|
1746
|
+
# For more information, see [Methods for accessing a bucket][1].
|
1666
1747
|
#
|
1667
|
-
# `$\{aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key\}`
|
1668
1748
|
#
|
1669
|
-
# where *bucket* is your bucket name and *key* is the object in the
|
1670
|
-
# bucket to which you are linking.
|
1671
1749
|
#
|
1672
|
-
#
|
1750
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html
|
1673
1751
|
#
|
1674
1752
|
# @option params [String] :document
|
1675
1753
|
# The job document. Required if you don't specify a value for
|
@@ -1689,11 +1767,18 @@ module Aws::IoT
|
|
1689
1767
|
# a thing when the thing is added to a target group, even after the job
|
1690
1768
|
# was completed by all things originally in the group.
|
1691
1769
|
#
|
1770
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs for
|
1771
|
+
# dynamic thing group targets. By using continuous jobs, devices that
|
1772
|
+
# join the group receive the job execution even after the job has been
|
1773
|
+
# created.
|
1774
|
+
#
|
1775
|
+
# </note>
|
1776
|
+
#
|
1692
1777
|
# @option params [Types::JobExecutionsRolloutConfig] :job_executions_rollout_config
|
1693
1778
|
# Allows you to create a staged rollout of the job.
|
1694
1779
|
#
|
1695
1780
|
# @option params [Types::AbortConfig] :abort_config
|
1696
|
-
# Allows you to create criteria to abort a job.
|
1781
|
+
# Allows you to create the criteria to abort a job.
|
1697
1782
|
#
|
1698
1783
|
# @option params [Types::TimeoutConfig] :timeout_config
|
1699
1784
|
# Specifies the amount of time each device has to finish its execution
|
@@ -1721,9 +1806,30 @@ module Aws::IoT
|
|
1721
1806
|
# @option params [String] :job_template_arn
|
1722
1807
|
# The ARN of the job template used to create the job.
|
1723
1808
|
#
|
1809
|
+
# @option params [Types::JobExecutionsRetryConfig] :job_executions_retry_config
|
1810
|
+
# Allows you to create the criteria to retry a job.
|
1811
|
+
#
|
1724
1812
|
# @option params [Hash<String,String>] :document_parameters
|
1725
|
-
# Parameters of
|
1726
|
-
# job document.
|
1813
|
+
# Parameters of an Amazon Web Services managed template that you can
|
1814
|
+
# specify to create the job document.
|
1815
|
+
#
|
1816
|
+
# <note markdown="1"> `documentParameters` can only be used when creating jobs from Amazon
|
1817
|
+
# Web Services managed templates. This parameter can't be used with
|
1818
|
+
# custom job templates or to create jobs from them.
|
1819
|
+
#
|
1820
|
+
# </note>
|
1821
|
+
#
|
1822
|
+
# @option params [Types::SchedulingConfig] :scheduling_config
|
1823
|
+
# The configuration that allows you to schedule a job for a future date
|
1824
|
+
# and time in addition to specifying the end behavior for each job
|
1825
|
+
# execution.
|
1826
|
+
#
|
1827
|
+
# @option params [Array<String>] :destination_package_versions
|
1828
|
+
# The package version Amazon Resource Names (ARNs) that are installed on
|
1829
|
+
# the device when the job successfully completes.
|
1830
|
+
#
|
1831
|
+
# **Note:**The following Length Constraints relates to a single string.
|
1832
|
+
# Up to five strings are allowed.
|
1727
1833
|
#
|
1728
1834
|
# @return [Types::CreateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1729
1835
|
#
|
@@ -1776,9 +1882,29 @@ module Aws::IoT
|
|
1776
1882
|
# ],
|
1777
1883
|
# namespace_id: "NamespaceId",
|
1778
1884
|
# job_template_arn: "JobTemplateArn",
|
1885
|
+
# job_executions_retry_config: {
|
1886
|
+
# criteria_list: [ # required
|
1887
|
+
# {
|
1888
|
+
# failure_type: "FAILED", # required, accepts FAILED, TIMED_OUT, ALL
|
1889
|
+
# number_of_retries: 1, # required
|
1890
|
+
# },
|
1891
|
+
# ],
|
1892
|
+
# },
|
1779
1893
|
# document_parameters: {
|
1780
1894
|
# "ParameterKey" => "ParameterValue",
|
1781
1895
|
# },
|
1896
|
+
# scheduling_config: {
|
1897
|
+
# start_time: "StringDateTime",
|
1898
|
+
# end_time: "StringDateTime",
|
1899
|
+
# end_behavior: "STOP_ROLLOUT", # accepts STOP_ROLLOUT, CANCEL, FORCE_CANCEL
|
1900
|
+
# maintenance_windows: [
|
1901
|
+
# {
|
1902
|
+
# start_time: "CronExpression", # required
|
1903
|
+
# duration_in_minutes: 1, # required
|
1904
|
+
# },
|
1905
|
+
# ],
|
1906
|
+
# },
|
1907
|
+
# destination_package_versions: ["PackageVersionArn"],
|
1782
1908
|
# })
|
1783
1909
|
#
|
1784
1910
|
# @example Response structure
|
@@ -1810,20 +1936,18 @@ module Aws::IoT
|
|
1810
1936
|
# The ARN of the job to use as the basis for the job template.
|
1811
1937
|
#
|
1812
1938
|
# @option params [String] :document_source
|
1813
|
-
# An S3 link
|
1814
|
-
# 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`.
|
1815
1942
|
#
|
1816
|
-
#
|
1817
|
-
#
|
1943
|
+
# For example, `--document-source
|
1944
|
+
# https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0`
|
1818
1945
|
#
|
1819
|
-
#
|
1946
|
+
# For more information, see [Methods for accessing a bucket][1].
|
1820
1947
|
#
|
1821
|
-
# `$\{aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key\}`
|
1822
1948
|
#
|
1823
|
-
# where *bucket* is your bucket name and *key* is the object in the
|
1824
|
-
# bucket to which you are linking.
|
1825
1949
|
#
|
1826
|
-
#
|
1950
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html
|
1827
1951
|
#
|
1828
1952
|
# @option params [String] :document
|
1829
1953
|
# The job document. Required if you don't specify a value for
|
@@ -1851,6 +1975,20 @@ module Aws::IoT
|
|
1851
1975
|
# @option params [Array<Types::Tag>] :tags
|
1852
1976
|
# Metadata that can be used to manage the job template.
|
1853
1977
|
#
|
1978
|
+
# @option params [Types::JobExecutionsRetryConfig] :job_executions_retry_config
|
1979
|
+
# Allows you to create the criteria to retry a job.
|
1980
|
+
#
|
1981
|
+
# @option params [Array<Types::MaintenanceWindow>] :maintenance_windows
|
1982
|
+
# Allows you to configure an optional maintenance window for the rollout
|
1983
|
+
# of a job document to all devices in the target group for a job.
|
1984
|
+
#
|
1985
|
+
# @option params [Array<String>] :destination_package_versions
|
1986
|
+
# The package version Amazon Resource Names (ARNs) that are installed on
|
1987
|
+
# the device when the job successfully completes.
|
1988
|
+
#
|
1989
|
+
# **Note:**The following Length Constraints relates to a single string.
|
1990
|
+
# Up to five strings are allowed.
|
1991
|
+
#
|
1854
1992
|
# @return [Types::CreateJobTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1855
1993
|
#
|
1856
1994
|
# * {Types::CreateJobTemplateResponse#job_template_arn #job_template_arn} => String
|
@@ -1898,6 +2036,21 @@ module Aws::IoT
|
|
1898
2036
|
# value: "TagValue",
|
1899
2037
|
# },
|
1900
2038
|
# ],
|
2039
|
+
# job_executions_retry_config: {
|
2040
|
+
# criteria_list: [ # required
|
2041
|
+
# {
|
2042
|
+
# failure_type: "FAILED", # required, accepts FAILED, TIMED_OUT, ALL
|
2043
|
+
# number_of_retries: 1, # required
|
2044
|
+
# },
|
2045
|
+
# ],
|
2046
|
+
# },
|
2047
|
+
# maintenance_windows: [
|
2048
|
+
# {
|
2049
|
+
# start_time: "CronExpression", # required
|
2050
|
+
# duration_in_minutes: 1, # required
|
2051
|
+
# },
|
2052
|
+
# ],
|
2053
|
+
# destination_package_versions: ["PackageVersionArn"],
|
1901
2054
|
# })
|
1902
2055
|
#
|
1903
2056
|
# @example Response structure
|
@@ -2093,7 +2246,8 @@ module Aws::IoT
|
|
2093
2246
|
# create an OTA update job.
|
2094
2247
|
#
|
2095
2248
|
# @option params [Hash<String,String>] :additional_parameters
|
2096
|
-
# 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.
|
2097
2251
|
#
|
2098
2252
|
# @option params [Array<Types::Tag>] :tags
|
2099
2253
|
# Metadata which can be used to manage updates.
|
@@ -2208,7 +2362,7 @@ module Aws::IoT
|
|
2208
2362
|
# resp.aws_iot_job_id #=> String
|
2209
2363
|
# resp.ota_update_arn #=> String
|
2210
2364
|
# resp.aws_iot_job_arn #=> String
|
2211
|
-
# resp.ota_update_status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED"
|
2365
|
+
# resp.ota_update_status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
2212
2366
|
#
|
2213
2367
|
# @overload create_ota_update(params = {})
|
2214
2368
|
# @param [Hash] params ({})
|
@@ -2217,6 +2371,144 @@ module Aws::IoT
|
|
2217
2371
|
req.send_request(options)
|
2218
2372
|
end
|
2219
2373
|
|
2374
|
+
# Creates an IoT software package that can be deployed to your fleet.
|
2375
|
+
#
|
2376
|
+
# Requires permission to access the [CreatePackage][1] and
|
2377
|
+
# [GetIndexingConfiguration][1] actions.
|
2378
|
+
#
|
2379
|
+
#
|
2380
|
+
#
|
2381
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2382
|
+
#
|
2383
|
+
# @option params [required, String] :package_name
|
2384
|
+
# The name of the new software package.
|
2385
|
+
#
|
2386
|
+
# @option params [String] :description
|
2387
|
+
# A summary of the package being created. This can be used to outline
|
2388
|
+
# the package's contents or purpose.
|
2389
|
+
#
|
2390
|
+
# @option params [Hash<String,String>] :tags
|
2391
|
+
# Metadata that can be used to manage the package.
|
2392
|
+
#
|
2393
|
+
# @option params [String] :client_token
|
2394
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
2395
|
+
# idempotency of the request. Don't reuse this client token if a new
|
2396
|
+
# idempotent request is required.
|
2397
|
+
#
|
2398
|
+
# **A suitable default value is auto-generated.** You should normally
|
2399
|
+
# not need to pass this option.**
|
2400
|
+
#
|
2401
|
+
# @return [Types::CreatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2402
|
+
#
|
2403
|
+
# * {Types::CreatePackageResponse#package_name #package_name} => String
|
2404
|
+
# * {Types::CreatePackageResponse#package_arn #package_arn} => String
|
2405
|
+
# * {Types::CreatePackageResponse#description #description} => String
|
2406
|
+
#
|
2407
|
+
# @example Request syntax with placeholder values
|
2408
|
+
#
|
2409
|
+
# resp = client.create_package({
|
2410
|
+
# package_name: "PackageName", # required
|
2411
|
+
# description: "ResourceDescription",
|
2412
|
+
# tags: {
|
2413
|
+
# "TagKey" => "TagValue",
|
2414
|
+
# },
|
2415
|
+
# client_token: "ClientToken",
|
2416
|
+
# })
|
2417
|
+
#
|
2418
|
+
# @example Response structure
|
2419
|
+
#
|
2420
|
+
# resp.package_name #=> String
|
2421
|
+
# resp.package_arn #=> String
|
2422
|
+
# resp.description #=> String
|
2423
|
+
#
|
2424
|
+
# @overload create_package(params = {})
|
2425
|
+
# @param [Hash] params ({})
|
2426
|
+
def create_package(params = {}, options = {})
|
2427
|
+
req = build_request(:create_package, params)
|
2428
|
+
req.send_request(options)
|
2429
|
+
end
|
2430
|
+
|
2431
|
+
# Creates a new version for an existing IoT software package.
|
2432
|
+
#
|
2433
|
+
# Requires permission to access the [CreatePackageVersion][1] and
|
2434
|
+
# [GetIndexingConfiguration][1] actions.
|
2435
|
+
#
|
2436
|
+
#
|
2437
|
+
#
|
2438
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2439
|
+
#
|
2440
|
+
# @option params [required, String] :package_name
|
2441
|
+
# The name of the associated software package.
|
2442
|
+
#
|
2443
|
+
# @option params [required, String] :version_name
|
2444
|
+
# The name of the new package version.
|
2445
|
+
#
|
2446
|
+
# @option params [String] :description
|
2447
|
+
# A summary of the package version being created. This can be used to
|
2448
|
+
# outline the package's contents or purpose.
|
2449
|
+
#
|
2450
|
+
# @option params [Hash<String,String>] :attributes
|
2451
|
+
# Metadata that can be used to define a package version’s configuration.
|
2452
|
+
# For example, the S3 file location, configuration options that are
|
2453
|
+
# being sent to the device or fleet.
|
2454
|
+
#
|
2455
|
+
# The combined size of all the attributes on a package version is
|
2456
|
+
# limited to 3KB.
|
2457
|
+
#
|
2458
|
+
# @option params [Hash<String,String>] :tags
|
2459
|
+
# Metadata that can be used to manage the package version.
|
2460
|
+
#
|
2461
|
+
# @option params [String] :client_token
|
2462
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
2463
|
+
# idempotency of the request. Don't reuse this client token if a new
|
2464
|
+
# idempotent request is required.
|
2465
|
+
#
|
2466
|
+
# **A suitable default value is auto-generated.** You should normally
|
2467
|
+
# not need to pass this option.**
|
2468
|
+
#
|
2469
|
+
# @return [Types::CreatePackageVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2470
|
+
#
|
2471
|
+
# * {Types::CreatePackageVersionResponse#package_version_arn #package_version_arn} => String
|
2472
|
+
# * {Types::CreatePackageVersionResponse#package_name #package_name} => String
|
2473
|
+
# * {Types::CreatePackageVersionResponse#version_name #version_name} => String
|
2474
|
+
# * {Types::CreatePackageVersionResponse#description #description} => String
|
2475
|
+
# * {Types::CreatePackageVersionResponse#attributes #attributes} => Hash<String,String>
|
2476
|
+
# * {Types::CreatePackageVersionResponse#status #status} => String
|
2477
|
+
# * {Types::CreatePackageVersionResponse#error_reason #error_reason} => String
|
2478
|
+
#
|
2479
|
+
# @example Request syntax with placeholder values
|
2480
|
+
#
|
2481
|
+
# resp = client.create_package_version({
|
2482
|
+
# package_name: "PackageName", # required
|
2483
|
+
# version_name: "VersionName", # required
|
2484
|
+
# description: "ResourceDescription",
|
2485
|
+
# attributes: {
|
2486
|
+
# "ResourceAttributeKey" => "ResourceAttributeValue",
|
2487
|
+
# },
|
2488
|
+
# tags: {
|
2489
|
+
# "TagKey" => "TagValue",
|
2490
|
+
# },
|
2491
|
+
# client_token: "ClientToken",
|
2492
|
+
# })
|
2493
|
+
#
|
2494
|
+
# @example Response structure
|
2495
|
+
#
|
2496
|
+
# resp.package_version_arn #=> String
|
2497
|
+
# resp.package_name #=> String
|
2498
|
+
# resp.version_name #=> String
|
2499
|
+
# resp.description #=> String
|
2500
|
+
# resp.attributes #=> Hash
|
2501
|
+
# resp.attributes["ResourceAttributeKey"] #=> String
|
2502
|
+
# resp.status #=> String, one of "DRAFT", "PUBLISHED", "DEPRECATED"
|
2503
|
+
# resp.error_reason #=> String
|
2504
|
+
#
|
2505
|
+
# @overload create_package_version(params = {})
|
2506
|
+
# @param [Hash] params ({})
|
2507
|
+
def create_package_version(params = {}, options = {})
|
2508
|
+
req = build_request(:create_package_version, params)
|
2509
|
+
req.send_request(options)
|
2510
|
+
end
|
2511
|
+
|
2220
2512
|
# Creates an IoT policy.
|
2221
2513
|
#
|
2222
2514
|
# The created policy is the default version for the policy. This
|
@@ -2383,7 +2675,7 @@ module Aws::IoT
|
|
2383
2675
|
req.send_request(options)
|
2384
2676
|
end
|
2385
2677
|
|
2386
|
-
# Creates a
|
2678
|
+
# Creates a provisioning template.
|
2387
2679
|
#
|
2388
2680
|
# Requires permission to access the [CreateProvisioningTemplate][1]
|
2389
2681
|
# action.
|
@@ -2393,26 +2685,32 @@ module Aws::IoT
|
|
2393
2685
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2394
2686
|
#
|
2395
2687
|
# @option params [required, String] :template_name
|
2396
|
-
# The name of the
|
2688
|
+
# The name of the provisioning template.
|
2397
2689
|
#
|
2398
2690
|
# @option params [String] :description
|
2399
|
-
# The description of the
|
2691
|
+
# The description of the provisioning template.
|
2400
2692
|
#
|
2401
2693
|
# @option params [required, String] :template_body
|
2402
|
-
# The JSON formatted contents of the
|
2694
|
+
# The JSON formatted contents of the provisioning template.
|
2403
2695
|
#
|
2404
2696
|
# @option params [Boolean] :enabled
|
2405
|
-
# True to enable the
|
2697
|
+
# True to enable the provisioning template, otherwise false.
|
2406
2698
|
#
|
2407
2699
|
# @option params [required, String] :provisioning_role_arn
|
2408
|
-
# The role ARN for the role associated with the
|
2409
|
-
#
|
2700
|
+
# The role ARN for the role associated with the provisioning template.
|
2701
|
+
# This IoT role grants permission to provision a device.
|
2410
2702
|
#
|
2411
2703
|
# @option params [Types::ProvisioningHook] :pre_provisioning_hook
|
2412
|
-
# Creates a pre-provisioning hook template.
|
2704
|
+
# Creates a pre-provisioning hook template. Only supports template of
|
2705
|
+
# type `FLEET_PROVISIONING`. For more information about provisioning
|
2706
|
+
# template types, see [type][1].
|
2707
|
+
#
|
2708
|
+
#
|
2709
|
+
#
|
2710
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_CreateProvisioningTemplate.html#iot-CreateProvisioningTemplate-request-type
|
2413
2711
|
#
|
2414
2712
|
# @option params [Array<Types::Tag>] :tags
|
2415
|
-
# Metadata which can be used to manage the
|
2713
|
+
# Metadata which can be used to manage the provisioning template.
|
2416
2714
|
#
|
2417
2715
|
# <note markdown="1"> For URI Request parameters use format:
|
2418
2716
|
# ...key1=value1&key2=value2...
|
@@ -2425,6 +2723,17 @@ module Aws::IoT
|
|
2425
2723
|
#
|
2426
2724
|
# </note>
|
2427
2725
|
#
|
2726
|
+
# @option params [String] :type
|
2727
|
+
# The type you define in a provisioning template. You can create a
|
2728
|
+
# template with only one type. You can't change the template type after
|
2729
|
+
# its creation. The default value is `FLEET_PROVISIONING`. For more
|
2730
|
+
# information about provisioning template, see: [Provisioning
|
2731
|
+
# template][1].
|
2732
|
+
#
|
2733
|
+
#
|
2734
|
+
#
|
2735
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html
|
2736
|
+
#
|
2428
2737
|
# @return [Types::CreateProvisioningTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2429
2738
|
#
|
2430
2739
|
# * {Types::CreateProvisioningTemplateResponse#template_arn #template_arn} => String
|
@@ -2449,6 +2758,7 @@ module Aws::IoT
|
|
2449
2758
|
# value: "TagValue",
|
2450
2759
|
# },
|
2451
2760
|
# ],
|
2761
|
+
# type: "FLEET_PROVISIONING", # accepts FLEET_PROVISIONING, JITP
|
2452
2762
|
# })
|
2453
2763
|
#
|
2454
2764
|
# @example Response structure
|
@@ -2464,7 +2774,7 @@ module Aws::IoT
|
|
2464
2774
|
req.send_request(options)
|
2465
2775
|
end
|
2466
2776
|
|
2467
|
-
# Creates a new version of a
|
2777
|
+
# Creates a new version of a provisioning template.
|
2468
2778
|
#
|
2469
2779
|
# Requires permission to access the
|
2470
2780
|
# [CreateProvisioningTemplateVersion][1] action.
|
@@ -2474,10 +2784,10 @@ module Aws::IoT
|
|
2474
2784
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2475
2785
|
#
|
2476
2786
|
# @option params [required, String] :template_name
|
2477
|
-
# The name of the
|
2787
|
+
# The name of the provisioning template.
|
2478
2788
|
#
|
2479
2789
|
# @option params [required, String] :template_body
|
2480
|
-
# The JSON formatted contents of the
|
2790
|
+
# The JSON formatted contents of the provisioning template.
|
2481
2791
|
#
|
2482
2792
|
# @option params [Boolean] :set_as_default
|
2483
2793
|
# Sets a fleet provision template version as the default version.
|
@@ -2530,6 +2840,9 @@ module Aws::IoT
|
|
2530
2840
|
# How long (in seconds) the credentials will be valid. The default value
|
2531
2841
|
# is 3,600 seconds.
|
2532
2842
|
#
|
2843
|
+
# This value must be less than or equal to the maximum session duration
|
2844
|
+
# of the IAM role that the role alias references.
|
2845
|
+
#
|
2533
2846
|
# @option params [Array<Types::Tag>] :tags
|
2534
2847
|
# Metadata which can be used to manage the role alias.
|
2535
2848
|
#
|
@@ -3105,6 +3418,19 @@ module Aws::IoT
|
|
3105
3418
|
# role_arn: "AwsArn", # required
|
3106
3419
|
# topic: "TopicPattern", # required
|
3107
3420
|
# qos: 1,
|
3421
|
+
# headers: {
|
3422
|
+
# payload_format_indicator: "PayloadFormatIndicator",
|
3423
|
+
# content_type: "ContentType",
|
3424
|
+
# response_topic: "ResponseTopic",
|
3425
|
+
# correlation_data: "CorrelationData",
|
3426
|
+
# message_expiry: "MessageExpiry",
|
3427
|
+
# user_properties: [
|
3428
|
+
# {
|
3429
|
+
# key: "UserPropertyKey", # required
|
3430
|
+
# value: "UserPropertyValue", # required
|
3431
|
+
# },
|
3432
|
+
# ],
|
3433
|
+
# },
|
3108
3434
|
# },
|
3109
3435
|
# s3: {
|
3110
3436
|
# role_arn: "AwsArn", # required
|
@@ -3135,6 +3461,7 @@ module Aws::IoT
|
|
3135
3461
|
# cloudwatch_logs: {
|
3136
3462
|
# role_arn: "AwsArn", # required
|
3137
3463
|
# log_group_name: "LogGroupName", # required
|
3464
|
+
# batch_mode: false,
|
3138
3465
|
# },
|
3139
3466
|
# elasticsearch: {
|
3140
3467
|
# role_arn: "AwsArn", # required
|
@@ -3230,6 +3557,12 @@ module Aws::IoT
|
|
3230
3557
|
# client_properties: { # required
|
3231
3558
|
# "String" => "String",
|
3232
3559
|
# },
|
3560
|
+
# headers: [
|
3561
|
+
# {
|
3562
|
+
# key: "KafkaHeaderKey", # required
|
3563
|
+
# value: "KafkaHeaderValue", # required
|
3564
|
+
# },
|
3565
|
+
# ],
|
3233
3566
|
# },
|
3234
3567
|
# open_search: {
|
3235
3568
|
# role_arn: "AwsArn", # required
|
@@ -3238,6 +3571,17 @@ module Aws::IoT
|
|
3238
3571
|
# type: "ElasticsearchType", # required
|
3239
3572
|
# id: "ElasticsearchId", # required
|
3240
3573
|
# },
|
3574
|
+
# location: {
|
3575
|
+
# role_arn: "AwsArn", # required
|
3576
|
+
# tracker_name: "String", # required
|
3577
|
+
# device_id: "String", # required
|
3578
|
+
# timestamp: {
|
3579
|
+
# value: "String", # required
|
3580
|
+
# unit: "String",
|
3581
|
+
# },
|
3582
|
+
# latitude: "String", # required
|
3583
|
+
# longitude: "String", # required
|
3584
|
+
# },
|
3241
3585
|
# },
|
3242
3586
|
# ],
|
3243
3587
|
# rule_disabled: false,
|
@@ -3283,6 +3627,19 @@ module Aws::IoT
|
|
3283
3627
|
# role_arn: "AwsArn", # required
|
3284
3628
|
# topic: "TopicPattern", # required
|
3285
3629
|
# qos: 1,
|
3630
|
+
# headers: {
|
3631
|
+
# payload_format_indicator: "PayloadFormatIndicator",
|
3632
|
+
# content_type: "ContentType",
|
3633
|
+
# response_topic: "ResponseTopic",
|
3634
|
+
# correlation_data: "CorrelationData",
|
3635
|
+
# message_expiry: "MessageExpiry",
|
3636
|
+
# user_properties: [
|
3637
|
+
# {
|
3638
|
+
# key: "UserPropertyKey", # required
|
3639
|
+
# value: "UserPropertyValue", # required
|
3640
|
+
# },
|
3641
|
+
# ],
|
3642
|
+
# },
|
3286
3643
|
# },
|
3287
3644
|
# s3: {
|
3288
3645
|
# role_arn: "AwsArn", # required
|
@@ -3313,6 +3670,7 @@ module Aws::IoT
|
|
3313
3670
|
# cloudwatch_logs: {
|
3314
3671
|
# role_arn: "AwsArn", # required
|
3315
3672
|
# log_group_name: "LogGroupName", # required
|
3673
|
+
# batch_mode: false,
|
3316
3674
|
# },
|
3317
3675
|
# elasticsearch: {
|
3318
3676
|
# role_arn: "AwsArn", # required
|
@@ -3408,6 +3766,12 @@ module Aws::IoT
|
|
3408
3766
|
# client_properties: { # required
|
3409
3767
|
# "String" => "String",
|
3410
3768
|
# },
|
3769
|
+
# headers: [
|
3770
|
+
# {
|
3771
|
+
# key: "KafkaHeaderKey", # required
|
3772
|
+
# value: "KafkaHeaderValue", # required
|
3773
|
+
# },
|
3774
|
+
# ],
|
3411
3775
|
# },
|
3412
3776
|
# open_search: {
|
3413
3777
|
# role_arn: "AwsArn", # required
|
@@ -3416,6 +3780,17 @@ module Aws::IoT
|
|
3416
3780
|
# type: "ElasticsearchType", # required
|
3417
3781
|
# id: "ElasticsearchId", # required
|
3418
3782
|
# },
|
3783
|
+
# location: {
|
3784
|
+
# role_arn: "AwsArn", # required
|
3785
|
+
# tracker_name: "String", # required
|
3786
|
+
# device_id: "String", # required
|
3787
|
+
# timestamp: {
|
3788
|
+
# value: "String", # required
|
3789
|
+
# unit: "String",
|
3790
|
+
# },
|
3791
|
+
# latitude: "String", # required
|
3792
|
+
# longitude: "String", # required
|
3793
|
+
# },
|
3419
3794
|
# },
|
3420
3795
|
# },
|
3421
3796
|
# tags: "String",
|
@@ -3547,6 +3922,12 @@ module Aws::IoT
|
|
3547
3922
|
# account: "AwsAccountId",
|
3548
3923
|
# iam_role_arn: "RoleArn",
|
3549
3924
|
# role_alias_arn: "RoleAliasArn",
|
3925
|
+
# issuer_certificate_identifier: {
|
3926
|
+
# issuer_certificate_subject: "IssuerCertificateSubject",
|
3927
|
+
# issuer_id: "IssuerId",
|
3928
|
+
# issuer_certificate_serial_number: "IssuerCertificateSerialNumber",
|
3929
|
+
# },
|
3930
|
+
# device_certificate_arn: "CertificateArn",
|
3550
3931
|
# },
|
3551
3932
|
# })
|
3552
3933
|
#
|
@@ -4054,6 +4435,81 @@ module Aws::IoT
|
|
4054
4435
|
req.send_request(options)
|
4055
4436
|
end
|
4056
4437
|
|
4438
|
+
# Deletes a specific version from a software package.
|
4439
|
+
#
|
4440
|
+
# **Note:** All package versions must be deleted before deleting the
|
4441
|
+
# software package.
|
4442
|
+
#
|
4443
|
+
# Requires permission to access the [DeletePackageVersion][1] action.
|
4444
|
+
#
|
4445
|
+
#
|
4446
|
+
#
|
4447
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4448
|
+
#
|
4449
|
+
# @option params [required, String] :package_name
|
4450
|
+
# The name of the target software package.
|
4451
|
+
#
|
4452
|
+
# @option params [String] :client_token
|
4453
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
4454
|
+
# idempotency of the request. Don't reuse this client token if a new
|
4455
|
+
# idempotent request is required.
|
4456
|
+
#
|
4457
|
+
# **A suitable default value is auto-generated.** You should normally
|
4458
|
+
# not need to pass this option.**
|
4459
|
+
#
|
4460
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4461
|
+
#
|
4462
|
+
# @example Request syntax with placeholder values
|
4463
|
+
#
|
4464
|
+
# resp = client.delete_package({
|
4465
|
+
# package_name: "PackageName", # required
|
4466
|
+
# client_token: "ClientToken",
|
4467
|
+
# })
|
4468
|
+
#
|
4469
|
+
# @overload delete_package(params = {})
|
4470
|
+
# @param [Hash] params ({})
|
4471
|
+
def delete_package(params = {}, options = {})
|
4472
|
+
req = build_request(:delete_package, params)
|
4473
|
+
req.send_request(options)
|
4474
|
+
end
|
4475
|
+
|
4476
|
+
# Deletes a specific version from a software package.
|
4477
|
+
#
|
4478
|
+
# **Note:** If a package version is designated as default, you must
|
4479
|
+
# remove the designation from the software package using the
|
4480
|
+
# UpdatePackage action.
|
4481
|
+
#
|
4482
|
+
# @option params [required, String] :package_name
|
4483
|
+
# The name of the associated software package.
|
4484
|
+
#
|
4485
|
+
# @option params [required, String] :version_name
|
4486
|
+
# The name of the target package version.
|
4487
|
+
#
|
4488
|
+
# @option params [String] :client_token
|
4489
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
4490
|
+
# idempotency of the request. Don't reuse this client token if a new
|
4491
|
+
# idempotent request is required.
|
4492
|
+
#
|
4493
|
+
# **A suitable default value is auto-generated.** You should normally
|
4494
|
+
# not need to pass this option.**
|
4495
|
+
#
|
4496
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4497
|
+
#
|
4498
|
+
# @example Request syntax with placeholder values
|
4499
|
+
#
|
4500
|
+
# resp = client.delete_package_version({
|
4501
|
+
# package_name: "PackageName", # required
|
4502
|
+
# version_name: "VersionName", # required
|
4503
|
+
# client_token: "ClientToken",
|
4504
|
+
# })
|
4505
|
+
#
|
4506
|
+
# @overload delete_package_version(params = {})
|
4507
|
+
# @param [Hash] params ({})
|
4508
|
+
def delete_package_version(params = {}, options = {})
|
4509
|
+
req = build_request(:delete_package_version, params)
|
4510
|
+
req.send_request(options)
|
4511
|
+
end
|
4512
|
+
|
4057
4513
|
# Deletes the specified policy.
|
4058
4514
|
#
|
4059
4515
|
# A policy cannot be deleted if it has non-default versions or it is
|
@@ -4131,7 +4587,7 @@ module Aws::IoT
|
|
4131
4587
|
req.send_request(options)
|
4132
4588
|
end
|
4133
4589
|
|
4134
|
-
# Deletes a
|
4590
|
+
# Deletes a provisioning template.
|
4135
4591
|
#
|
4136
4592
|
# Requires permission to access the [DeleteProvisioningTemplate][1]
|
4137
4593
|
# action.
|
@@ -4158,7 +4614,7 @@ module Aws::IoT
|
|
4158
4614
|
req.send_request(options)
|
4159
4615
|
end
|
4160
4616
|
|
4161
|
-
# Deletes a
|
4617
|
+
# Deletes a provisioning template version.
|
4162
4618
|
#
|
4163
4619
|
# Requires permission to access the
|
4164
4620
|
# [DeleteProvisioningTemplateVersion][1] action.
|
@@ -4168,10 +4624,10 @@ module Aws::IoT
|
|
4168
4624
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4169
4625
|
#
|
4170
4626
|
# @option params [required, String] :template_name
|
4171
|
-
# The name of the
|
4627
|
+
# The name of the provisioning template version to delete.
|
4172
4628
|
#
|
4173
4629
|
# @option params [required, Integer] :version_id
|
4174
|
-
# The
|
4630
|
+
# The provisioning template version ID to delete.
|
4175
4631
|
#
|
4176
4632
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4177
4633
|
#
|
@@ -4485,7 +4941,7 @@ module Aws::IoT
|
|
4485
4941
|
# @example Request syntax with placeholder values
|
4486
4942
|
#
|
4487
4943
|
# resp = client.delete_v2_logging_level({
|
4488
|
-
# target_type: "DEFAULT", # required, accepts DEFAULT, THING_GROUP
|
4944
|
+
# target_type: "DEFAULT", # required, accepts DEFAULT, THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, EVENT_TYPE, DEVICE_DEFENDER
|
4489
4945
|
# target_name: "LogTargetName", # required
|
4490
4946
|
# })
|
4491
4947
|
#
|
@@ -4595,7 +5051,7 @@ module Aws::IoT
|
|
4595
5051
|
# resp.finding.task_start_time #=> Time
|
4596
5052
|
# resp.finding.finding_time #=> Time
|
4597
5053
|
# resp.finding.severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW"
|
4598
|
-
# resp.finding.non_compliant_resource.resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS", "ROLE_ALIAS", "IAM_ROLE"
|
5054
|
+
# resp.finding.non_compliant_resource.resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS", "ROLE_ALIAS", "IAM_ROLE", "ISSUER_CERTIFICATE"
|
4599
5055
|
# resp.finding.non_compliant_resource.resource_identifier.device_certificate_id #=> String
|
4600
5056
|
# resp.finding.non_compliant_resource.resource_identifier.ca_certificate_id #=> String
|
4601
5057
|
# resp.finding.non_compliant_resource.resource_identifier.cognito_identity_pool_id #=> String
|
@@ -4605,10 +5061,14 @@ module Aws::IoT
|
|
4605
5061
|
# resp.finding.non_compliant_resource.resource_identifier.account #=> String
|
4606
5062
|
# resp.finding.non_compliant_resource.resource_identifier.iam_role_arn #=> String
|
4607
5063
|
# resp.finding.non_compliant_resource.resource_identifier.role_alias_arn #=> String
|
5064
|
+
# resp.finding.non_compliant_resource.resource_identifier.issuer_certificate_identifier.issuer_certificate_subject #=> String
|
5065
|
+
# resp.finding.non_compliant_resource.resource_identifier.issuer_certificate_identifier.issuer_id #=> String
|
5066
|
+
# resp.finding.non_compliant_resource.resource_identifier.issuer_certificate_identifier.issuer_certificate_serial_number #=> String
|
5067
|
+
# resp.finding.non_compliant_resource.resource_identifier.device_certificate_arn #=> String
|
4608
5068
|
# resp.finding.non_compliant_resource.additional_info #=> Hash
|
4609
5069
|
# resp.finding.non_compliant_resource.additional_info["String"] #=> String
|
4610
5070
|
# resp.finding.related_resources #=> Array
|
4611
|
-
# resp.finding.related_resources[0].resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS", "ROLE_ALIAS", "IAM_ROLE"
|
5071
|
+
# resp.finding.related_resources[0].resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS", "ROLE_ALIAS", "IAM_ROLE", "ISSUER_CERTIFICATE"
|
4612
5072
|
# resp.finding.related_resources[0].resource_identifier.device_certificate_id #=> String
|
4613
5073
|
# resp.finding.related_resources[0].resource_identifier.ca_certificate_id #=> String
|
4614
5074
|
# resp.finding.related_resources[0].resource_identifier.cognito_identity_pool_id #=> String
|
@@ -4618,6 +5078,10 @@ module Aws::IoT
|
|
4618
5078
|
# resp.finding.related_resources[0].resource_identifier.account #=> String
|
4619
5079
|
# resp.finding.related_resources[0].resource_identifier.iam_role_arn #=> String
|
4620
5080
|
# resp.finding.related_resources[0].resource_identifier.role_alias_arn #=> String
|
5081
|
+
# resp.finding.related_resources[0].resource_identifier.issuer_certificate_identifier.issuer_certificate_subject #=> String
|
5082
|
+
# resp.finding.related_resources[0].resource_identifier.issuer_certificate_identifier.issuer_id #=> String
|
5083
|
+
# resp.finding.related_resources[0].resource_identifier.issuer_certificate_identifier.issuer_certificate_serial_number #=> String
|
5084
|
+
# resp.finding.related_resources[0].resource_identifier.device_certificate_arn #=> String
|
4621
5085
|
# resp.finding.related_resources[0].additional_info #=> Hash
|
4622
5086
|
# resp.finding.related_resources[0].additional_info["String"] #=> String
|
4623
5087
|
# resp.finding.reason_for_non_compliance #=> String
|
@@ -4731,6 +5195,12 @@ module Aws::IoT
|
|
4731
5195
|
# account: "AwsAccountId",
|
4732
5196
|
# iam_role_arn: "RoleArn",
|
4733
5197
|
# role_alias_arn: "RoleAliasArn",
|
5198
|
+
# issuer_certificate_identifier: {
|
5199
|
+
# issuer_certificate_subject: "IssuerCertificateSubject",
|
5200
|
+
# issuer_id: "IssuerId",
|
5201
|
+
# issuer_certificate_serial_number: "IssuerCertificateSerialNumber",
|
5202
|
+
# },
|
5203
|
+
# device_certificate_arn: "CertificateArn",
|
4734
5204
|
# },
|
4735
5205
|
# })
|
4736
5206
|
#
|
@@ -4746,6 +5216,10 @@ module Aws::IoT
|
|
4746
5216
|
# resp.resource_identifier.account #=> String
|
4747
5217
|
# resp.resource_identifier.iam_role_arn #=> String
|
4748
5218
|
# resp.resource_identifier.role_alias_arn #=> String
|
5219
|
+
# resp.resource_identifier.issuer_certificate_identifier.issuer_certificate_subject #=> String
|
5220
|
+
# resp.resource_identifier.issuer_certificate_identifier.issuer_id #=> String
|
5221
|
+
# resp.resource_identifier.issuer_certificate_identifier.issuer_certificate_serial_number #=> String
|
5222
|
+
# resp.resource_identifier.device_certificate_arn #=> String
|
4749
5223
|
# resp.expiration_date #=> Time
|
4750
5224
|
# resp.suppress_indefinitely #=> Boolean
|
4751
5225
|
# resp.description #=> String
|
@@ -4845,6 +5319,7 @@ module Aws::IoT
|
|
4845
5319
|
# resp.authorizer_description.creation_date #=> Time
|
4846
5320
|
# resp.authorizer_description.last_modified_date #=> Time
|
4847
5321
|
# resp.authorizer_description.signing_disabled #=> Boolean
|
5322
|
+
# resp.authorizer_description.enable_caching_for_http #=> Boolean
|
4848
5323
|
#
|
4849
5324
|
# @overload describe_authorizer(params = {})
|
4850
5325
|
# @param [Hash] params ({})
|
@@ -4931,8 +5406,10 @@ module Aws::IoT
|
|
4931
5406
|
# resp.certificate_description.generation_id #=> String
|
4932
5407
|
# resp.certificate_description.validity.not_before #=> Time
|
4933
5408
|
# resp.certificate_description.validity.not_after #=> Time
|
5409
|
+
# resp.certificate_description.certificate_mode #=> String, one of "DEFAULT", "SNI_ONLY"
|
4934
5410
|
# resp.registration_config.template_body #=> String
|
4935
5411
|
# resp.registration_config.role_arn #=> String
|
5412
|
+
# resp.registration_config.template_name #=> String
|
4936
5413
|
#
|
4937
5414
|
# @overload describe_ca_certificate(params = {})
|
4938
5415
|
# @param [Hash] params ({})
|
@@ -5059,6 +5536,7 @@ module Aws::IoT
|
|
5059
5536
|
# resp.authorizer_description.creation_date #=> Time
|
5060
5537
|
# resp.authorizer_description.last_modified_date #=> Time
|
5061
5538
|
# resp.authorizer_description.signing_disabled #=> Boolean
|
5539
|
+
# resp.authorizer_description.enable_caching_for_http #=> Boolean
|
5062
5540
|
#
|
5063
5541
|
# @overload describe_default_authorizer(params = {})
|
5064
5542
|
# @param [Hash] params ({})
|
@@ -5194,6 +5672,7 @@ module Aws::IoT
|
|
5194
5672
|
# * {Types::DescribeDomainConfigurationResponse#service_type #service_type} => String
|
5195
5673
|
# * {Types::DescribeDomainConfigurationResponse#domain_type #domain_type} => String
|
5196
5674
|
# * {Types::DescribeDomainConfigurationResponse#last_status_change_date #last_status_change_date} => Time
|
5675
|
+
# * {Types::DescribeDomainConfigurationResponse#tls_config #tls_config} => Types::TlsConfig
|
5197
5676
|
#
|
5198
5677
|
# @example Request syntax with placeholder values
|
5199
5678
|
#
|
@@ -5216,6 +5695,7 @@ module Aws::IoT
|
|
5216
5695
|
# resp.service_type #=> String, one of "DATA", "CREDENTIAL_PROVIDER", "JOBS"
|
5217
5696
|
# resp.domain_type #=> String, one of "ENDPOINT", "AWS_MANAGED", "CUSTOMER_MANAGED"
|
5218
5697
|
# resp.last_status_change_date #=> Time
|
5698
|
+
# resp.tls_config.security_policy #=> String
|
5219
5699
|
#
|
5220
5700
|
# @overload describe_domain_configuration(params = {})
|
5221
5701
|
# @param [Hash] params ({})
|
@@ -5258,7 +5738,8 @@ module Aws::IoT
|
|
5258
5738
|
#
|
5259
5739
|
# We strongly recommend that customers use the newer `iot:Data-ATS`
|
5260
5740
|
# endpoint type to avoid issues related to the widespread distrust of
|
5261
|
-
# Symantec certificate authorities.
|
5741
|
+
# Symantec certificate authorities. ATS Signed Certificates are more
|
5742
|
+
# secure and are trusted by most popular browsers.
|
5262
5743
|
#
|
5263
5744
|
# @return [Types::DescribeEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5264
5745
|
#
|
@@ -5432,7 +5913,7 @@ module Aws::IoT
|
|
5432
5913
|
# resp.job.job_arn #=> String
|
5433
5914
|
# resp.job.job_id #=> String
|
5434
5915
|
# resp.job.target_selection #=> String, one of "CONTINUOUS", "SNAPSHOT"
|
5435
|
-
# resp.job.status #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED", "DELETION_IN_PROGRESS"
|
5916
|
+
# resp.job.status #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED", "DELETION_IN_PROGRESS", "SCHEDULED"
|
5436
5917
|
# resp.job.force_canceled #=> Boolean
|
5437
5918
|
# resp.job.reason_code #=> String
|
5438
5919
|
# resp.job.comment #=> String
|
@@ -5467,8 +5948,22 @@ module Aws::IoT
|
|
5467
5948
|
# resp.job.timeout_config.in_progress_timeout_in_minutes #=> Integer
|
5468
5949
|
# resp.job.namespace_id #=> String
|
5469
5950
|
# resp.job.job_template_arn #=> String
|
5951
|
+
# resp.job.job_executions_retry_config.criteria_list #=> Array
|
5952
|
+
# resp.job.job_executions_retry_config.criteria_list[0].failure_type #=> String, one of "FAILED", "TIMED_OUT", "ALL"
|
5953
|
+
# resp.job.job_executions_retry_config.criteria_list[0].number_of_retries #=> Integer
|
5470
5954
|
# resp.job.document_parameters #=> Hash
|
5471
5955
|
# resp.job.document_parameters["ParameterKey"] #=> String
|
5956
|
+
# resp.job.is_concurrent #=> Boolean
|
5957
|
+
# resp.job.scheduling_config.start_time #=> String
|
5958
|
+
# resp.job.scheduling_config.end_time #=> String
|
5959
|
+
# resp.job.scheduling_config.end_behavior #=> String, one of "STOP_ROLLOUT", "CANCEL", "FORCE_CANCEL"
|
5960
|
+
# resp.job.scheduling_config.maintenance_windows #=> Array
|
5961
|
+
# resp.job.scheduling_config.maintenance_windows[0].start_time #=> String
|
5962
|
+
# resp.job.scheduling_config.maintenance_windows[0].duration_in_minutes #=> Integer
|
5963
|
+
# resp.job.scheduled_job_rollouts #=> Array
|
5964
|
+
# resp.job.scheduled_job_rollouts[0].start_time #=> String
|
5965
|
+
# resp.job.destination_package_versions #=> Array
|
5966
|
+
# resp.job.destination_package_versions[0] #=> String
|
5472
5967
|
#
|
5473
5968
|
# @overload describe_job(params = {})
|
5474
5969
|
# @param [Hash] params ({})
|
@@ -5546,6 +6041,9 @@ module Aws::IoT
|
|
5546
6041
|
# * {Types::DescribeJobTemplateResponse#job_executions_rollout_config #job_executions_rollout_config} => Types::JobExecutionsRolloutConfig
|
5547
6042
|
# * {Types::DescribeJobTemplateResponse#abort_config #abort_config} => Types::AbortConfig
|
5548
6043
|
# * {Types::DescribeJobTemplateResponse#timeout_config #timeout_config} => Types::TimeoutConfig
|
6044
|
+
# * {Types::DescribeJobTemplateResponse#job_executions_retry_config #job_executions_retry_config} => Types::JobExecutionsRetryConfig
|
6045
|
+
# * {Types::DescribeJobTemplateResponse#maintenance_windows #maintenance_windows} => Array<Types::MaintenanceWindow>
|
6046
|
+
# * {Types::DescribeJobTemplateResponse#destination_package_versions #destination_package_versions} => Array<String>
|
5549
6047
|
#
|
5550
6048
|
# @example Request syntax with placeholder values
|
5551
6049
|
#
|
@@ -5574,6 +6072,14 @@ module Aws::IoT
|
|
5574
6072
|
# resp.abort_config.criteria_list[0].threshold_percentage #=> Float
|
5575
6073
|
# resp.abort_config.criteria_list[0].min_number_of_executed_things #=> Integer
|
5576
6074
|
# resp.timeout_config.in_progress_timeout_in_minutes #=> Integer
|
6075
|
+
# resp.job_executions_retry_config.criteria_list #=> Array
|
6076
|
+
# resp.job_executions_retry_config.criteria_list[0].failure_type #=> String, one of "FAILED", "TIMED_OUT", "ALL"
|
6077
|
+
# resp.job_executions_retry_config.criteria_list[0].number_of_retries #=> Integer
|
6078
|
+
# resp.maintenance_windows #=> Array
|
6079
|
+
# resp.maintenance_windows[0].start_time #=> String
|
6080
|
+
# resp.maintenance_windows[0].duration_in_minutes #=> Integer
|
6081
|
+
# resp.destination_package_versions #=> Array
|
6082
|
+
# resp.destination_package_versions[0] #=> String
|
5577
6083
|
#
|
5578
6084
|
# @overload describe_job_template(params = {})
|
5579
6085
|
# @param [Hash] params ({})
|
@@ -5686,7 +6192,7 @@ module Aws::IoT
|
|
5686
6192
|
req.send_request(options)
|
5687
6193
|
end
|
5688
6194
|
|
5689
|
-
# Returns information about a
|
6195
|
+
# Returns information about a provisioning template.
|
5690
6196
|
#
|
5691
6197
|
# Requires permission to access the [DescribeProvisioningTemplate][1]
|
5692
6198
|
# action.
|
@@ -5696,7 +6202,7 @@ module Aws::IoT
|
|
5696
6202
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5697
6203
|
#
|
5698
6204
|
# @option params [required, String] :template_name
|
5699
|
-
# The name of the
|
6205
|
+
# The name of the provisioning template.
|
5700
6206
|
#
|
5701
6207
|
# @return [Types::DescribeProvisioningTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5702
6208
|
#
|
@@ -5710,6 +6216,7 @@ module Aws::IoT
|
|
5710
6216
|
# * {Types::DescribeProvisioningTemplateResponse#enabled #enabled} => Boolean
|
5711
6217
|
# * {Types::DescribeProvisioningTemplateResponse#provisioning_role_arn #provisioning_role_arn} => String
|
5712
6218
|
# * {Types::DescribeProvisioningTemplateResponse#pre_provisioning_hook #pre_provisioning_hook} => Types::ProvisioningHook
|
6219
|
+
# * {Types::DescribeProvisioningTemplateResponse#type #type} => String
|
5713
6220
|
#
|
5714
6221
|
# @example Request syntax with placeholder values
|
5715
6222
|
#
|
@@ -5730,6 +6237,7 @@ module Aws::IoT
|
|
5730
6237
|
# resp.provisioning_role_arn #=> String
|
5731
6238
|
# resp.pre_provisioning_hook.payload_version #=> String
|
5732
6239
|
# resp.pre_provisioning_hook.target_arn #=> String
|
6240
|
+
# resp.type #=> String, one of "FLEET_PROVISIONING", "JITP"
|
5733
6241
|
#
|
5734
6242
|
# @overload describe_provisioning_template(params = {})
|
5735
6243
|
# @param [Hash] params ({})
|
@@ -5738,7 +6246,7 @@ module Aws::IoT
|
|
5738
6246
|
req.send_request(options)
|
5739
6247
|
end
|
5740
6248
|
|
5741
|
-
# Returns information about a
|
6249
|
+
# Returns information about a provisioning template version.
|
5742
6250
|
#
|
5743
6251
|
# Requires permission to access the
|
5744
6252
|
# [DescribeProvisioningTemplateVersion][1] action.
|
@@ -5751,7 +6259,7 @@ module Aws::IoT
|
|
5751
6259
|
# The template name.
|
5752
6260
|
#
|
5753
6261
|
# @option params [required, Integer] :version_id
|
5754
|
-
# The
|
6262
|
+
# The provisioning template version ID.
|
5755
6263
|
#
|
5756
6264
|
# @return [Types::DescribeProvisioningTemplateVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5757
6265
|
#
|
@@ -6223,9 +6731,9 @@ module Aws::IoT
|
|
6223
6731
|
|
6224
6732
|
# Removes the specified policy from the specified certificate.
|
6225
6733
|
#
|
6226
|
-
#
|
6227
|
-
#
|
6228
|
-
#
|
6734
|
+
# **Note:** This action is deprecated and works as expected for backward
|
6735
|
+
# compatibility, but we won't add enhancements. Use DetachPolicy
|
6736
|
+
# instead.
|
6229
6737
|
#
|
6230
6738
|
# Requires permission to access the [DetachPrincipalPolicy][1] action.
|
6231
6739
|
#
|
@@ -6240,10 +6748,9 @@ module Aws::IoT
|
|
6240
6748
|
# The principal.
|
6241
6749
|
#
|
6242
6750
|
# Valid principals are CertificateArn
|
6243
|
-
# (arn:aws:iot:*region
|
6244
|
-
#
|
6245
|
-
# (
|
6246
|
-
# CognitoId (*region*\:*id*).
|
6751
|
+
# (arn:aws:iot:*region*:*accountId*:cert/*certificateId*), thingGroupArn
|
6752
|
+
# (arn:aws:iot:*region*:*accountId*:thinggroup/*groupName*) and
|
6753
|
+
# CognitoId (*region*:*id*).
|
6247
6754
|
#
|
6248
6755
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6249
6756
|
#
|
@@ -6399,7 +6906,7 @@ module Aws::IoT
|
|
6399
6906
|
#
|
6400
6907
|
# @option params [Integer] :max_results
|
6401
6908
|
# The maximum number of results to return at one time. The default is
|
6402
|
-
#
|
6909
|
+
# 10.
|
6403
6910
|
#
|
6404
6911
|
# @option params [String] :next_token
|
6405
6912
|
# The token for the next set of results.
|
@@ -6551,10 +7058,9 @@ module Aws::IoT
|
|
6551
7058
|
#
|
6552
7059
|
# @option params [String] :principal
|
6553
7060
|
# The principal. Valid principals are CertificateArn
|
6554
|
-
# (arn:aws:iot:*region
|
6555
|
-
#
|
6556
|
-
# (
|
6557
|
-
# CognitoId (*region*\:*id*).
|
7061
|
+
# (arn:aws:iot:*region*:*accountId*:cert/*certificateId*), thingGroupArn
|
7062
|
+
# (arn:aws:iot:*region*:*accountId*:thinggroup/*groupName*) and
|
7063
|
+
# CognitoId (*region*:*id*).
|
6558
7064
|
#
|
6559
7065
|
# @option params [String] :cognito_identity_pool_id
|
6560
7066
|
# The Cognito identity pool ID.
|
@@ -6614,6 +7120,8 @@ module Aws::IoT
|
|
6614
7120
|
# resp.thing_indexing_configuration.custom_fields #=> Array
|
6615
7121
|
# resp.thing_indexing_configuration.custom_fields[0].name #=> String
|
6616
7122
|
# resp.thing_indexing_configuration.custom_fields[0].type #=> String, one of "Number", "String", "Boolean"
|
7123
|
+
# resp.thing_indexing_configuration.filter.named_shadow_names #=> Array
|
7124
|
+
# resp.thing_indexing_configuration.filter.named_shadow_names[0] #=> String
|
6617
7125
|
# resp.thing_group_indexing_configuration.thing_group_indexing_mode #=> String, one of "OFF", "ON"
|
6618
7126
|
# resp.thing_group_indexing_configuration.managed_fields #=> Array
|
6619
7127
|
# resp.thing_group_indexing_configuration.managed_fields[0].name #=> String
|
@@ -6751,7 +7259,7 @@ module Aws::IoT
|
|
6751
7259
|
# resp.ota_update_info.ota_update_files[0].code_signing.custom_code_signing.signature_algorithm #=> String
|
6752
7260
|
# resp.ota_update_info.ota_update_files[0].attributes #=> Hash
|
6753
7261
|
# resp.ota_update_info.ota_update_files[0].attributes["AttributeKey"] #=> String
|
6754
|
-
# resp.ota_update_info.ota_update_status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED"
|
7262
|
+
# resp.ota_update_info.ota_update_status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
6755
7263
|
# resp.ota_update_info.aws_iot_job_id #=> String
|
6756
7264
|
# resp.ota_update_info.aws_iot_job_arn #=> String
|
6757
7265
|
# resp.ota_update_info.error_info.code #=> String
|
@@ -6766,62 +7274,182 @@ module Aws::IoT
|
|
6766
7274
|
req.send_request(options)
|
6767
7275
|
end
|
6768
7276
|
|
6769
|
-
#
|
6770
|
-
# groupings. The default percentile groupings are: 1,5,25,50,75,95,99,
|
6771
|
-
# although you can specify your own when you call `GetPercentiles`. This
|
6772
|
-
# function returns a value for each percentile group specified (or the
|
6773
|
-
# default percentile groupings). The percentile group "1" contains the
|
6774
|
-
# aggregated field value that occurs in approximately one percent of the
|
6775
|
-
# values that match the query. The percentile group "5" contains the
|
6776
|
-
# aggregated field value that occurs in approximately five percent of
|
6777
|
-
# the values that match the query, and so on. The result is an
|
6778
|
-
# approximation, the more values that match the query, the more accurate
|
6779
|
-
# the percentile values.
|
7277
|
+
# Gets information about the specified software package.
|
6780
7278
|
#
|
6781
|
-
# Requires permission to access the [
|
7279
|
+
# Requires permission to access the [GetPackage][1] action.
|
6782
7280
|
#
|
6783
7281
|
#
|
6784
7282
|
#
|
6785
7283
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6786
7284
|
#
|
6787
|
-
# @option params [String] :
|
6788
|
-
# The name of the
|
6789
|
-
#
|
6790
|
-
# @option params [required, String] :query_string
|
6791
|
-
# The search query string.
|
6792
|
-
#
|
6793
|
-
# @option params [String] :aggregation_field
|
6794
|
-
# The field to aggregate.
|
6795
|
-
#
|
6796
|
-
# @option params [String] :query_version
|
6797
|
-
# The query version.
|
6798
|
-
#
|
6799
|
-
# @option params [Array<Float>] :percents
|
6800
|
-
# The percentile groups returned.
|
7285
|
+
# @option params [required, String] :package_name
|
7286
|
+
# The name of the target software package.
|
6801
7287
|
#
|
6802
|
-
# @return [Types::
|
7288
|
+
# @return [Types::GetPackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6803
7289
|
#
|
6804
|
-
# * {Types::
|
7290
|
+
# * {Types::GetPackageResponse#package_name #package_name} => String
|
7291
|
+
# * {Types::GetPackageResponse#package_arn #package_arn} => String
|
7292
|
+
# * {Types::GetPackageResponse#description #description} => String
|
7293
|
+
# * {Types::GetPackageResponse#default_version_name #default_version_name} => String
|
7294
|
+
# * {Types::GetPackageResponse#creation_date #creation_date} => Time
|
7295
|
+
# * {Types::GetPackageResponse#last_modified_date #last_modified_date} => Time
|
6805
7296
|
#
|
6806
7297
|
# @example Request syntax with placeholder values
|
6807
7298
|
#
|
6808
|
-
# resp = client.
|
6809
|
-
#
|
6810
|
-
# query_string: "QueryString", # required
|
6811
|
-
# aggregation_field: "AggregationField",
|
6812
|
-
# query_version: "QueryVersion",
|
6813
|
-
# percents: [1.0],
|
7299
|
+
# resp = client.get_package({
|
7300
|
+
# package_name: "PackageName", # required
|
6814
7301
|
# })
|
6815
7302
|
#
|
6816
7303
|
# @example Response structure
|
6817
7304
|
#
|
6818
|
-
# resp.
|
6819
|
-
# resp.
|
6820
|
-
# resp.
|
7305
|
+
# resp.package_name #=> String
|
7306
|
+
# resp.package_arn #=> String
|
7307
|
+
# resp.description #=> String
|
7308
|
+
# resp.default_version_name #=> String
|
7309
|
+
# resp.creation_date #=> Time
|
7310
|
+
# resp.last_modified_date #=> Time
|
6821
7311
|
#
|
6822
|
-
# @overload
|
7312
|
+
# @overload get_package(params = {})
|
6823
7313
|
# @param [Hash] params ({})
|
6824
|
-
def
|
7314
|
+
def get_package(params = {}, options = {})
|
7315
|
+
req = build_request(:get_package, params)
|
7316
|
+
req.send_request(options)
|
7317
|
+
end
|
7318
|
+
|
7319
|
+
# Gets information about the specified software package's
|
7320
|
+
# configuration.
|
7321
|
+
#
|
7322
|
+
# Requires permission to access the [GetPackageConfiguration][1] action.
|
7323
|
+
#
|
7324
|
+
#
|
7325
|
+
#
|
7326
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7327
|
+
#
|
7328
|
+
# @return [Types::GetPackageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7329
|
+
#
|
7330
|
+
# * {Types::GetPackageConfigurationResponse#version_update_by_jobs_config #version_update_by_jobs_config} => Types::VersionUpdateByJobsConfig
|
7331
|
+
#
|
7332
|
+
# @example Response structure
|
7333
|
+
#
|
7334
|
+
# resp.version_update_by_jobs_config.enabled #=> Boolean
|
7335
|
+
# resp.version_update_by_jobs_config.role_arn #=> String
|
7336
|
+
#
|
7337
|
+
# @overload get_package_configuration(params = {})
|
7338
|
+
# @param [Hash] params ({})
|
7339
|
+
def get_package_configuration(params = {}, options = {})
|
7340
|
+
req = build_request(:get_package_configuration, params)
|
7341
|
+
req.send_request(options)
|
7342
|
+
end
|
7343
|
+
|
7344
|
+
# Gets information about the specified package version.
|
7345
|
+
#
|
7346
|
+
# Requires permission to access the [GetPackageVersion][1] action.
|
7347
|
+
#
|
7348
|
+
#
|
7349
|
+
#
|
7350
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7351
|
+
#
|
7352
|
+
# @option params [required, String] :package_name
|
7353
|
+
# The name of the associated package.
|
7354
|
+
#
|
7355
|
+
# @option params [required, String] :version_name
|
7356
|
+
# The name of the target package version.
|
7357
|
+
#
|
7358
|
+
# @return [Types::GetPackageVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7359
|
+
#
|
7360
|
+
# * {Types::GetPackageVersionResponse#package_version_arn #package_version_arn} => String
|
7361
|
+
# * {Types::GetPackageVersionResponse#package_name #package_name} => String
|
7362
|
+
# * {Types::GetPackageVersionResponse#version_name #version_name} => String
|
7363
|
+
# * {Types::GetPackageVersionResponse#description #description} => String
|
7364
|
+
# * {Types::GetPackageVersionResponse#attributes #attributes} => Hash<String,String>
|
7365
|
+
# * {Types::GetPackageVersionResponse#status #status} => String
|
7366
|
+
# * {Types::GetPackageVersionResponse#error_reason #error_reason} => String
|
7367
|
+
# * {Types::GetPackageVersionResponse#creation_date #creation_date} => Time
|
7368
|
+
# * {Types::GetPackageVersionResponse#last_modified_date #last_modified_date} => Time
|
7369
|
+
#
|
7370
|
+
# @example Request syntax with placeholder values
|
7371
|
+
#
|
7372
|
+
# resp = client.get_package_version({
|
7373
|
+
# package_name: "PackageName", # required
|
7374
|
+
# version_name: "VersionName", # required
|
7375
|
+
# })
|
7376
|
+
#
|
7377
|
+
# @example Response structure
|
7378
|
+
#
|
7379
|
+
# resp.package_version_arn #=> String
|
7380
|
+
# resp.package_name #=> String
|
7381
|
+
# resp.version_name #=> String
|
7382
|
+
# resp.description #=> String
|
7383
|
+
# resp.attributes #=> Hash
|
7384
|
+
# resp.attributes["ResourceAttributeKey"] #=> String
|
7385
|
+
# resp.status #=> String, one of "DRAFT", "PUBLISHED", "DEPRECATED"
|
7386
|
+
# resp.error_reason #=> String
|
7387
|
+
# resp.creation_date #=> Time
|
7388
|
+
# resp.last_modified_date #=> Time
|
7389
|
+
#
|
7390
|
+
# @overload get_package_version(params = {})
|
7391
|
+
# @param [Hash] params ({})
|
7392
|
+
def get_package_version(params = {}, options = {})
|
7393
|
+
req = build_request(:get_package_version, params)
|
7394
|
+
req.send_request(options)
|
7395
|
+
end
|
7396
|
+
|
7397
|
+
# Groups the aggregated values that match the query into percentile
|
7398
|
+
# groupings. The default percentile groupings are: 1,5,25,50,75,95,99,
|
7399
|
+
# although you can specify your own when you call `GetPercentiles`. This
|
7400
|
+
# function returns a value for each percentile group specified (or the
|
7401
|
+
# default percentile groupings). The percentile group "1" contains the
|
7402
|
+
# aggregated field value that occurs in approximately one percent of the
|
7403
|
+
# values that match the query. The percentile group "5" contains the
|
7404
|
+
# aggregated field value that occurs in approximately five percent of
|
7405
|
+
# the values that match the query, and so on. The result is an
|
7406
|
+
# approximation, the more values that match the query, the more accurate
|
7407
|
+
# the percentile values.
|
7408
|
+
#
|
7409
|
+
# Requires permission to access the [GetPercentiles][1] action.
|
7410
|
+
#
|
7411
|
+
#
|
7412
|
+
#
|
7413
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7414
|
+
#
|
7415
|
+
# @option params [String] :index_name
|
7416
|
+
# The name of the index to search.
|
7417
|
+
#
|
7418
|
+
# @option params [required, String] :query_string
|
7419
|
+
# The search query string.
|
7420
|
+
#
|
7421
|
+
# @option params [String] :aggregation_field
|
7422
|
+
# The field to aggregate.
|
7423
|
+
#
|
7424
|
+
# @option params [String] :query_version
|
7425
|
+
# The query version.
|
7426
|
+
#
|
7427
|
+
# @option params [Array<Float>] :percents
|
7428
|
+
# The percentile groups returned.
|
7429
|
+
#
|
7430
|
+
# @return [Types::GetPercentilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7431
|
+
#
|
7432
|
+
# * {Types::GetPercentilesResponse#percentiles #percentiles} => Array<Types::PercentPair>
|
7433
|
+
#
|
7434
|
+
# @example Request syntax with placeholder values
|
7435
|
+
#
|
7436
|
+
# resp = client.get_percentiles({
|
7437
|
+
# index_name: "IndexName",
|
7438
|
+
# query_string: "QueryString", # required
|
7439
|
+
# aggregation_field: "AggregationField",
|
7440
|
+
# query_version: "QueryVersion",
|
7441
|
+
# percents: [1.0],
|
7442
|
+
# })
|
7443
|
+
#
|
7444
|
+
# @example Response structure
|
7445
|
+
#
|
7446
|
+
# resp.percentiles #=> Array
|
7447
|
+
# resp.percentiles[0].percent #=> Float
|
7448
|
+
# resp.percentiles[0].value #=> Float
|
7449
|
+
#
|
7450
|
+
# @overload get_percentiles(params = {})
|
7451
|
+
# @param [Hash] params ({})
|
7452
|
+
def get_percentiles(params = {}, options = {})
|
6825
7453
|
req = build_request(:get_percentiles, params)
|
6826
7454
|
req.send_request(options)
|
6827
7455
|
end
|
@@ -7055,6 +7683,14 @@ module Aws::IoT
|
|
7055
7683
|
# resp.rule.actions[0].republish.role_arn #=> String
|
7056
7684
|
# resp.rule.actions[0].republish.topic #=> String
|
7057
7685
|
# resp.rule.actions[0].republish.qos #=> Integer
|
7686
|
+
# resp.rule.actions[0].republish.headers.payload_format_indicator #=> String
|
7687
|
+
# resp.rule.actions[0].republish.headers.content_type #=> String
|
7688
|
+
# resp.rule.actions[0].republish.headers.response_topic #=> String
|
7689
|
+
# resp.rule.actions[0].republish.headers.correlation_data #=> String
|
7690
|
+
# resp.rule.actions[0].republish.headers.message_expiry #=> String
|
7691
|
+
# resp.rule.actions[0].republish.headers.user_properties #=> Array
|
7692
|
+
# resp.rule.actions[0].republish.headers.user_properties[0].key #=> String
|
7693
|
+
# resp.rule.actions[0].republish.headers.user_properties[0].value #=> String
|
7058
7694
|
# resp.rule.actions[0].s3.role_arn #=> String
|
7059
7695
|
# resp.rule.actions[0].s3.bucket_name #=> String
|
7060
7696
|
# resp.rule.actions[0].s3.key #=> String
|
@@ -7075,6 +7711,7 @@ module Aws::IoT
|
|
7075
7711
|
# resp.rule.actions[0].cloudwatch_alarm.state_value #=> String
|
7076
7712
|
# resp.rule.actions[0].cloudwatch_logs.role_arn #=> String
|
7077
7713
|
# resp.rule.actions[0].cloudwatch_logs.log_group_name #=> String
|
7714
|
+
# resp.rule.actions[0].cloudwatch_logs.batch_mode #=> Boolean
|
7078
7715
|
# resp.rule.actions[0].elasticsearch.role_arn #=> String
|
7079
7716
|
# resp.rule.actions[0].elasticsearch.endpoint #=> String
|
7080
7717
|
# resp.rule.actions[0].elasticsearch.index #=> String
|
@@ -7129,11 +7766,21 @@ module Aws::IoT
|
|
7129
7766
|
# resp.rule.actions[0].kafka.partition #=> String
|
7130
7767
|
# resp.rule.actions[0].kafka.client_properties #=> Hash
|
7131
7768
|
# resp.rule.actions[0].kafka.client_properties["String"] #=> String
|
7769
|
+
# resp.rule.actions[0].kafka.headers #=> Array
|
7770
|
+
# resp.rule.actions[0].kafka.headers[0].key #=> String
|
7771
|
+
# resp.rule.actions[0].kafka.headers[0].value #=> String
|
7132
7772
|
# resp.rule.actions[0].open_search.role_arn #=> String
|
7133
7773
|
# resp.rule.actions[0].open_search.endpoint #=> String
|
7134
7774
|
# resp.rule.actions[0].open_search.index #=> String
|
7135
7775
|
# resp.rule.actions[0].open_search.type #=> String
|
7136
7776
|
# resp.rule.actions[0].open_search.id #=> String
|
7777
|
+
# resp.rule.actions[0].location.role_arn #=> String
|
7778
|
+
# resp.rule.actions[0].location.tracker_name #=> String
|
7779
|
+
# resp.rule.actions[0].location.device_id #=> String
|
7780
|
+
# resp.rule.actions[0].location.timestamp.value #=> String
|
7781
|
+
# resp.rule.actions[0].location.timestamp.unit #=> String
|
7782
|
+
# resp.rule.actions[0].location.latitude #=> String
|
7783
|
+
# resp.rule.actions[0].location.longitude #=> String
|
7137
7784
|
# resp.rule.rule_disabled #=> Boolean
|
7138
7785
|
# resp.rule.aws_iot_sql_version #=> String
|
7139
7786
|
# resp.rule.error_action.dynamo_db.table_name #=> String
|
@@ -7161,6 +7808,14 @@ module Aws::IoT
|
|
7161
7808
|
# resp.rule.error_action.republish.role_arn #=> String
|
7162
7809
|
# resp.rule.error_action.republish.topic #=> String
|
7163
7810
|
# resp.rule.error_action.republish.qos #=> Integer
|
7811
|
+
# resp.rule.error_action.republish.headers.payload_format_indicator #=> String
|
7812
|
+
# resp.rule.error_action.republish.headers.content_type #=> String
|
7813
|
+
# resp.rule.error_action.republish.headers.response_topic #=> String
|
7814
|
+
# resp.rule.error_action.republish.headers.correlation_data #=> String
|
7815
|
+
# resp.rule.error_action.republish.headers.message_expiry #=> String
|
7816
|
+
# resp.rule.error_action.republish.headers.user_properties #=> Array
|
7817
|
+
# resp.rule.error_action.republish.headers.user_properties[0].key #=> String
|
7818
|
+
# resp.rule.error_action.republish.headers.user_properties[0].value #=> String
|
7164
7819
|
# resp.rule.error_action.s3.role_arn #=> String
|
7165
7820
|
# resp.rule.error_action.s3.bucket_name #=> String
|
7166
7821
|
# resp.rule.error_action.s3.key #=> String
|
@@ -7181,6 +7836,7 @@ module Aws::IoT
|
|
7181
7836
|
# resp.rule.error_action.cloudwatch_alarm.state_value #=> String
|
7182
7837
|
# resp.rule.error_action.cloudwatch_logs.role_arn #=> String
|
7183
7838
|
# resp.rule.error_action.cloudwatch_logs.log_group_name #=> String
|
7839
|
+
# resp.rule.error_action.cloudwatch_logs.batch_mode #=> Boolean
|
7184
7840
|
# resp.rule.error_action.elasticsearch.role_arn #=> String
|
7185
7841
|
# resp.rule.error_action.elasticsearch.endpoint #=> String
|
7186
7842
|
# resp.rule.error_action.elasticsearch.index #=> String
|
@@ -7235,11 +7891,21 @@ module Aws::IoT
|
|
7235
7891
|
# resp.rule.error_action.kafka.partition #=> String
|
7236
7892
|
# resp.rule.error_action.kafka.client_properties #=> Hash
|
7237
7893
|
# resp.rule.error_action.kafka.client_properties["String"] #=> String
|
7894
|
+
# resp.rule.error_action.kafka.headers #=> Array
|
7895
|
+
# resp.rule.error_action.kafka.headers[0].key #=> String
|
7896
|
+
# resp.rule.error_action.kafka.headers[0].value #=> String
|
7238
7897
|
# resp.rule.error_action.open_search.role_arn #=> String
|
7239
7898
|
# resp.rule.error_action.open_search.endpoint #=> String
|
7240
7899
|
# resp.rule.error_action.open_search.index #=> String
|
7241
7900
|
# resp.rule.error_action.open_search.type #=> String
|
7242
7901
|
# resp.rule.error_action.open_search.id #=> String
|
7902
|
+
# resp.rule.error_action.location.role_arn #=> String
|
7903
|
+
# resp.rule.error_action.location.tracker_name #=> String
|
7904
|
+
# resp.rule.error_action.location.device_id #=> String
|
7905
|
+
# resp.rule.error_action.location.timestamp.value #=> String
|
7906
|
+
# resp.rule.error_action.location.timestamp.unit #=> String
|
7907
|
+
# resp.rule.error_action.location.latitude #=> String
|
7908
|
+
# resp.rule.error_action.location.longitude #=> String
|
7243
7909
|
#
|
7244
7910
|
# @overload get_topic_rule(params = {})
|
7245
7911
|
# @param [Hash] params ({})
|
@@ -7430,10 +8096,9 @@ module Aws::IoT
|
|
7430
8096
|
# @option params [required, String] :target
|
7431
8097
|
# The group or principal for which the policies will be listed. Valid
|
7432
8098
|
# principals are CertificateArn
|
7433
|
-
# (arn:aws:iot:*region
|
7434
|
-
#
|
7435
|
-
# (
|
7436
|
-
# CognitoId (*region*\:*id*).
|
8099
|
+
# (arn:aws:iot:*region*:*accountId*:cert/*certificateId*), thingGroupArn
|
8100
|
+
# (arn:aws:iot:*region*:*accountId*:thinggroup/*groupName*) and
|
8101
|
+
# CognitoId (*region*:*id*).
|
7437
8102
|
#
|
7438
8103
|
# @option params [Boolean] :recursive
|
7439
8104
|
# When true, recursively list attached policies.
|
@@ -7542,6 +8207,12 @@ module Aws::IoT
|
|
7542
8207
|
# account: "AwsAccountId",
|
7543
8208
|
# iam_role_arn: "RoleArn",
|
7544
8209
|
# role_alias_arn: "RoleAliasArn",
|
8210
|
+
# issuer_certificate_identifier: {
|
8211
|
+
# issuer_certificate_subject: "IssuerCertificateSubject",
|
8212
|
+
# issuer_id: "IssuerId",
|
8213
|
+
# issuer_certificate_serial_number: "IssuerCertificateSerialNumber",
|
8214
|
+
# },
|
8215
|
+
# device_certificate_arn: "CertificateArn",
|
7545
8216
|
# },
|
7546
8217
|
# max_results: 1,
|
7547
8218
|
# next_token: "NextToken",
|
@@ -7559,7 +8230,7 @@ module Aws::IoT
|
|
7559
8230
|
# resp.findings[0].task_start_time #=> Time
|
7560
8231
|
# resp.findings[0].finding_time #=> Time
|
7561
8232
|
# resp.findings[0].severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW"
|
7562
|
-
# resp.findings[0].non_compliant_resource.resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS", "ROLE_ALIAS", "IAM_ROLE"
|
8233
|
+
# resp.findings[0].non_compliant_resource.resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS", "ROLE_ALIAS", "IAM_ROLE", "ISSUER_CERTIFICATE"
|
7563
8234
|
# resp.findings[0].non_compliant_resource.resource_identifier.device_certificate_id #=> String
|
7564
8235
|
# resp.findings[0].non_compliant_resource.resource_identifier.ca_certificate_id #=> String
|
7565
8236
|
# resp.findings[0].non_compliant_resource.resource_identifier.cognito_identity_pool_id #=> String
|
@@ -7569,10 +8240,14 @@ module Aws::IoT
|
|
7569
8240
|
# resp.findings[0].non_compliant_resource.resource_identifier.account #=> String
|
7570
8241
|
# resp.findings[0].non_compliant_resource.resource_identifier.iam_role_arn #=> String
|
7571
8242
|
# resp.findings[0].non_compliant_resource.resource_identifier.role_alias_arn #=> String
|
8243
|
+
# resp.findings[0].non_compliant_resource.resource_identifier.issuer_certificate_identifier.issuer_certificate_subject #=> String
|
8244
|
+
# resp.findings[0].non_compliant_resource.resource_identifier.issuer_certificate_identifier.issuer_id #=> String
|
8245
|
+
# resp.findings[0].non_compliant_resource.resource_identifier.issuer_certificate_identifier.issuer_certificate_serial_number #=> String
|
8246
|
+
# resp.findings[0].non_compliant_resource.resource_identifier.device_certificate_arn #=> String
|
7572
8247
|
# resp.findings[0].non_compliant_resource.additional_info #=> Hash
|
7573
8248
|
# resp.findings[0].non_compliant_resource.additional_info["String"] #=> String
|
7574
8249
|
# resp.findings[0].related_resources #=> Array
|
7575
|
-
# resp.findings[0].related_resources[0].resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS", "ROLE_ALIAS", "IAM_ROLE"
|
8250
|
+
# resp.findings[0].related_resources[0].resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS", "ROLE_ALIAS", "IAM_ROLE", "ISSUER_CERTIFICATE"
|
7576
8251
|
# resp.findings[0].related_resources[0].resource_identifier.device_certificate_id #=> String
|
7577
8252
|
# resp.findings[0].related_resources[0].resource_identifier.ca_certificate_id #=> String
|
7578
8253
|
# resp.findings[0].related_resources[0].resource_identifier.cognito_identity_pool_id #=> String
|
@@ -7582,6 +8257,10 @@ module Aws::IoT
|
|
7582
8257
|
# resp.findings[0].related_resources[0].resource_identifier.account #=> String
|
7583
8258
|
# resp.findings[0].related_resources[0].resource_identifier.iam_role_arn #=> String
|
7584
8259
|
# resp.findings[0].related_resources[0].resource_identifier.role_alias_arn #=> String
|
8260
|
+
# resp.findings[0].related_resources[0].resource_identifier.issuer_certificate_identifier.issuer_certificate_subject #=> String
|
8261
|
+
# resp.findings[0].related_resources[0].resource_identifier.issuer_certificate_identifier.issuer_id #=> String
|
8262
|
+
# resp.findings[0].related_resources[0].resource_identifier.issuer_certificate_identifier.issuer_certificate_serial_number #=> String
|
8263
|
+
# resp.findings[0].related_resources[0].resource_identifier.device_certificate_arn #=> String
|
7585
8264
|
# resp.findings[0].related_resources[0].additional_info #=> Hash
|
7586
8265
|
# resp.findings[0].related_resources[0].additional_info["String"] #=> String
|
7587
8266
|
# resp.findings[0].reason_for_non_compliance #=> String
|
@@ -7784,6 +8463,12 @@ module Aws::IoT
|
|
7784
8463
|
# account: "AwsAccountId",
|
7785
8464
|
# iam_role_arn: "RoleArn",
|
7786
8465
|
# role_alias_arn: "RoleAliasArn",
|
8466
|
+
# issuer_certificate_identifier: {
|
8467
|
+
# issuer_certificate_subject: "IssuerCertificateSubject",
|
8468
|
+
# issuer_id: "IssuerId",
|
8469
|
+
# issuer_certificate_serial_number: "IssuerCertificateSerialNumber",
|
8470
|
+
# },
|
8471
|
+
# device_certificate_arn: "CertificateArn",
|
7787
8472
|
# },
|
7788
8473
|
# ascending_order: false,
|
7789
8474
|
# next_token: "NextToken",
|
@@ -7803,6 +8488,10 @@ module Aws::IoT
|
|
7803
8488
|
# resp.suppressions[0].resource_identifier.account #=> String
|
7804
8489
|
# resp.suppressions[0].resource_identifier.iam_role_arn #=> String
|
7805
8490
|
# resp.suppressions[0].resource_identifier.role_alias_arn #=> String
|
8491
|
+
# resp.suppressions[0].resource_identifier.issuer_certificate_identifier.issuer_certificate_subject #=> String
|
8492
|
+
# resp.suppressions[0].resource_identifier.issuer_certificate_identifier.issuer_id #=> String
|
8493
|
+
# resp.suppressions[0].resource_identifier.issuer_certificate_identifier.issuer_certificate_serial_number #=> String
|
8494
|
+
# resp.suppressions[0].resource_identifier.device_certificate_arn #=> String
|
7806
8495
|
# resp.suppressions[0].expiration_date #=> Time
|
7807
8496
|
# resp.suppressions[0].suppress_indefinitely #=> Boolean
|
7808
8497
|
# resp.suppressions[0].description #=> String
|
@@ -8000,6 +8689,9 @@ module Aws::IoT
|
|
8000
8689
|
# @option params [Boolean] :ascending_order
|
8001
8690
|
# Determines the order of the results.
|
8002
8691
|
#
|
8692
|
+
# @option params [String] :template_name
|
8693
|
+
# The name of the provisioning template.
|
8694
|
+
#
|
8003
8695
|
# @return [Types::ListCACertificatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8004
8696
|
#
|
8005
8697
|
# * {Types::ListCACertificatesResponse#certificates #certificates} => Array<Types::CACertificate>
|
@@ -8013,6 +8705,7 @@ module Aws::IoT
|
|
8013
8705
|
# page_size: 1,
|
8014
8706
|
# marker: "Marker",
|
8015
8707
|
# ascending_order: false,
|
8708
|
+
# template_name: "TemplateName",
|
8016
8709
|
# })
|
8017
8710
|
#
|
8018
8711
|
# @example Response structure
|
@@ -8559,6 +9252,7 @@ module Aws::IoT
|
|
8559
9252
|
# resp.execution_summaries[0].job_execution_summary.started_at #=> Time
|
8560
9253
|
# resp.execution_summaries[0].job_execution_summary.last_updated_at #=> Time
|
8561
9254
|
# resp.execution_summaries[0].job_execution_summary.execution_number #=> Integer
|
9255
|
+
# resp.execution_summaries[0].job_execution_summary.retry_attempt #=> Integer
|
8562
9256
|
# resp.next_token #=> String
|
8563
9257
|
#
|
8564
9258
|
# @overload list_job_executions_for_job(params = {})
|
@@ -8603,6 +9297,9 @@ module Aws::IoT
|
|
8603
9297
|
# @option params [String] :next_token
|
8604
9298
|
# The token to retrieve the next set of results.
|
8605
9299
|
#
|
9300
|
+
# @option params [String] :job_id
|
9301
|
+
# The unique identifier you assigned to this job when it was created.
|
9302
|
+
#
|
8606
9303
|
# @return [Types::ListJobExecutionsForThingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8607
9304
|
#
|
8608
9305
|
# * {Types::ListJobExecutionsForThingResponse#execution_summaries #execution_summaries} => Array<Types::JobExecutionSummaryForThing>
|
@@ -8618,6 +9315,7 @@ module Aws::IoT
|
|
8618
9315
|
# namespace_id: "NamespaceId",
|
8619
9316
|
# max_results: 1,
|
8620
9317
|
# next_token: "NextToken",
|
9318
|
+
# job_id: "JobId",
|
8621
9319
|
# })
|
8622
9320
|
#
|
8623
9321
|
# @example Response structure
|
@@ -8629,6 +9327,7 @@ module Aws::IoT
|
|
8629
9327
|
# resp.execution_summaries[0].job_execution_summary.started_at #=> Time
|
8630
9328
|
# resp.execution_summaries[0].job_execution_summary.last_updated_at #=> Time
|
8631
9329
|
# resp.execution_summaries[0].job_execution_summary.execution_number #=> Integer
|
9330
|
+
# resp.execution_summaries[0].job_execution_summary.retry_attempt #=> Integer
|
8632
9331
|
# resp.next_token #=> String
|
8633
9332
|
#
|
8634
9333
|
# @overload list_job_executions_for_thing(params = {})
|
@@ -8702,6 +9401,13 @@ module Aws::IoT
|
|
8702
9401
|
# a thing when the thing is added to a target group, even after the job
|
8703
9402
|
# was completed by all things originally in the group.
|
8704
9403
|
#
|
9404
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs for
|
9405
|
+
# dynamic thing group targets. By using continuous jobs, devices that
|
9406
|
+
# join the group receive the job execution even after the job has been
|
9407
|
+
# created.
|
9408
|
+
#
|
9409
|
+
# </note>
|
9410
|
+
#
|
8705
9411
|
# @option params [Integer] :max_results
|
8706
9412
|
# The maximum number of results to return per request.
|
8707
9413
|
#
|
@@ -8739,7 +9445,7 @@ module Aws::IoT
|
|
8739
9445
|
# @example Request syntax with placeholder values
|
8740
9446
|
#
|
8741
9447
|
# resp = client.list_jobs({
|
8742
|
-
# status: "IN_PROGRESS", # accepts IN_PROGRESS, CANCELED, COMPLETED, DELETION_IN_PROGRESS
|
9448
|
+
# status: "IN_PROGRESS", # accepts IN_PROGRESS, CANCELED, COMPLETED, DELETION_IN_PROGRESS, SCHEDULED
|
8743
9449
|
# target_selection: "CONTINUOUS", # accepts CONTINUOUS, SNAPSHOT
|
8744
9450
|
# max_results: 1,
|
8745
9451
|
# next_token: "NextToken",
|
@@ -8755,10 +9461,11 @@ module Aws::IoT
|
|
8755
9461
|
# resp.jobs[0].job_id #=> String
|
8756
9462
|
# resp.jobs[0].thing_group_id #=> String
|
8757
9463
|
# resp.jobs[0].target_selection #=> String, one of "CONTINUOUS", "SNAPSHOT"
|
8758
|
-
# resp.jobs[0].status #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED", "DELETION_IN_PROGRESS"
|
9464
|
+
# resp.jobs[0].status #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED", "DELETION_IN_PROGRESS", "SCHEDULED"
|
8759
9465
|
# resp.jobs[0].created_at #=> Time
|
8760
9466
|
# resp.jobs[0].last_updated_at #=> Time
|
8761
9467
|
# resp.jobs[0].completed_at #=> Time
|
9468
|
+
# resp.jobs[0].is_concurrent #=> Boolean
|
8762
9469
|
# resp.next_token #=> String
|
8763
9470
|
#
|
8764
9471
|
# @overload list_jobs(params = {})
|
@@ -8786,6 +9493,8 @@ module Aws::IoT
|
|
8786
9493
|
# * {Types::ListManagedJobTemplatesResponse#managed_job_templates #managed_job_templates} => Array<Types::ManagedJobTemplateSummary>
|
8787
9494
|
# * {Types::ListManagedJobTemplatesResponse#next_token #next_token} => String
|
8788
9495
|
#
|
9496
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9497
|
+
#
|
8789
9498
|
# @example Request syntax with placeholder values
|
8790
9499
|
#
|
8791
9500
|
# resp = client.list_managed_job_templates({
|
@@ -8812,6 +9521,78 @@ module Aws::IoT
|
|
8812
9521
|
req.send_request(options)
|
8813
9522
|
end
|
8814
9523
|
|
9524
|
+
# Lists the values reported for an IoT Device Defender metric
|
9525
|
+
# (device-side metric, cloud-side metric, or custom metric) by the given
|
9526
|
+
# thing during the specified time period.
|
9527
|
+
#
|
9528
|
+
# @option params [required, String] :thing_name
|
9529
|
+
# The name of the thing for which security profile metric values are
|
9530
|
+
# returned.
|
9531
|
+
#
|
9532
|
+
# @option params [required, String] :metric_name
|
9533
|
+
# The name of the security profile metric for which values are returned.
|
9534
|
+
#
|
9535
|
+
# @option params [String] :dimension_name
|
9536
|
+
# The dimension name.
|
9537
|
+
#
|
9538
|
+
# @option params [String] :dimension_value_operator
|
9539
|
+
# The dimension value operator.
|
9540
|
+
#
|
9541
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
9542
|
+
# The start of the time period for which metric values are returned.
|
9543
|
+
#
|
9544
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
9545
|
+
# The end of the time period for which metric values are returned.
|
9546
|
+
#
|
9547
|
+
# @option params [Integer] :max_results
|
9548
|
+
# The maximum number of results to return at one time.
|
9549
|
+
#
|
9550
|
+
# @option params [String] :next_token
|
9551
|
+
# The token for the next set of results.
|
9552
|
+
#
|
9553
|
+
# @return [Types::ListMetricValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9554
|
+
#
|
9555
|
+
# * {Types::ListMetricValuesResponse#metric_datum_list #metric_datum_list} => Array<Types::MetricDatum>
|
9556
|
+
# * {Types::ListMetricValuesResponse#next_token #next_token} => String
|
9557
|
+
#
|
9558
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9559
|
+
#
|
9560
|
+
# @example Request syntax with placeholder values
|
9561
|
+
#
|
9562
|
+
# resp = client.list_metric_values({
|
9563
|
+
# thing_name: "DeviceDefenderThingName", # required
|
9564
|
+
# metric_name: "BehaviorMetric", # required
|
9565
|
+
# dimension_name: "DimensionName",
|
9566
|
+
# dimension_value_operator: "IN", # accepts IN, NOT_IN
|
9567
|
+
# start_time: Time.now, # required
|
9568
|
+
# end_time: Time.now, # required
|
9569
|
+
# max_results: 1,
|
9570
|
+
# next_token: "NextToken",
|
9571
|
+
# })
|
9572
|
+
#
|
9573
|
+
# @example Response structure
|
9574
|
+
#
|
9575
|
+
# resp.metric_datum_list #=> Array
|
9576
|
+
# resp.metric_datum_list[0].timestamp #=> Time
|
9577
|
+
# resp.metric_datum_list[0].value.count #=> Integer
|
9578
|
+
# resp.metric_datum_list[0].value.cidrs #=> Array
|
9579
|
+
# resp.metric_datum_list[0].value.cidrs[0] #=> String
|
9580
|
+
# resp.metric_datum_list[0].value.ports #=> Array
|
9581
|
+
# resp.metric_datum_list[0].value.ports[0] #=> Integer
|
9582
|
+
# resp.metric_datum_list[0].value.number #=> Float
|
9583
|
+
# resp.metric_datum_list[0].value.numbers #=> Array
|
9584
|
+
# resp.metric_datum_list[0].value.numbers[0] #=> Float
|
9585
|
+
# resp.metric_datum_list[0].value.strings #=> Array
|
9586
|
+
# resp.metric_datum_list[0].value.strings[0] #=> String
|
9587
|
+
# resp.next_token #=> String
|
9588
|
+
#
|
9589
|
+
# @overload list_metric_values(params = {})
|
9590
|
+
# @param [Hash] params ({})
|
9591
|
+
def list_metric_values(params = {}, options = {})
|
9592
|
+
req = build_request(:list_metric_values, params)
|
9593
|
+
req.send_request(options)
|
9594
|
+
end
|
9595
|
+
|
8815
9596
|
# Gets a list of all mitigation actions that match the specified filter
|
8816
9597
|
# criteria.
|
8817
9598
|
#
|
@@ -8891,7 +9672,7 @@ module Aws::IoT
|
|
8891
9672
|
# resp = client.list_ota_updates({
|
8892
9673
|
# max_results: 1,
|
8893
9674
|
# next_token: "NextToken",
|
8894
|
-
# ota_update_status: "CREATE_PENDING", # accepts CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED
|
9675
|
+
# ota_update_status: "CREATE_PENDING", # accepts CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED, DELETE_IN_PROGRESS, DELETE_FAILED
|
8895
9676
|
# })
|
8896
9677
|
#
|
8897
9678
|
# @example Response structure
|
@@ -8961,6 +9742,108 @@ module Aws::IoT
|
|
8961
9742
|
req.send_request(options)
|
8962
9743
|
end
|
8963
9744
|
|
9745
|
+
# Lists the software package versions associated to the account.
|
9746
|
+
#
|
9747
|
+
# Requires permission to access the [ListPackageVersions][1] action.
|
9748
|
+
#
|
9749
|
+
#
|
9750
|
+
#
|
9751
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9752
|
+
#
|
9753
|
+
# @option params [required, String] :package_name
|
9754
|
+
# The name of the target software package.
|
9755
|
+
#
|
9756
|
+
# @option params [String] :status
|
9757
|
+
# The status of the package version. For more information, see [Package
|
9758
|
+
# version lifecycle][1].
|
9759
|
+
#
|
9760
|
+
#
|
9761
|
+
#
|
9762
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
|
9763
|
+
#
|
9764
|
+
# @option params [Integer] :max_results
|
9765
|
+
# The maximum number of results to return at one time.
|
9766
|
+
#
|
9767
|
+
# @option params [String] :next_token
|
9768
|
+
# The token for the next set of results.
|
9769
|
+
#
|
9770
|
+
# @return [Types::ListPackageVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9771
|
+
#
|
9772
|
+
# * {Types::ListPackageVersionsResponse#package_version_summaries #package_version_summaries} => Array<Types::PackageVersionSummary>
|
9773
|
+
# * {Types::ListPackageVersionsResponse#next_token #next_token} => String
|
9774
|
+
#
|
9775
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9776
|
+
#
|
9777
|
+
# @example Request syntax with placeholder values
|
9778
|
+
#
|
9779
|
+
# resp = client.list_package_versions({
|
9780
|
+
# package_name: "PackageName", # required
|
9781
|
+
# status: "DRAFT", # accepts DRAFT, PUBLISHED, DEPRECATED
|
9782
|
+
# max_results: 1,
|
9783
|
+
# next_token: "NextToken",
|
9784
|
+
# })
|
9785
|
+
#
|
9786
|
+
# @example Response structure
|
9787
|
+
#
|
9788
|
+
# resp.package_version_summaries #=> Array
|
9789
|
+
# resp.package_version_summaries[0].package_name #=> String
|
9790
|
+
# resp.package_version_summaries[0].version_name #=> String
|
9791
|
+
# resp.package_version_summaries[0].status #=> String, one of "DRAFT", "PUBLISHED", "DEPRECATED"
|
9792
|
+
# resp.package_version_summaries[0].creation_date #=> Time
|
9793
|
+
# resp.package_version_summaries[0].last_modified_date #=> Time
|
9794
|
+
# resp.next_token #=> String
|
9795
|
+
#
|
9796
|
+
# @overload list_package_versions(params = {})
|
9797
|
+
# @param [Hash] params ({})
|
9798
|
+
def list_package_versions(params = {}, options = {})
|
9799
|
+
req = build_request(:list_package_versions, params)
|
9800
|
+
req.send_request(options)
|
9801
|
+
end
|
9802
|
+
|
9803
|
+
# Lists the software packages associated to the account.
|
9804
|
+
#
|
9805
|
+
# Requires permission to access the [ListPackages][1] action.
|
9806
|
+
#
|
9807
|
+
#
|
9808
|
+
#
|
9809
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9810
|
+
#
|
9811
|
+
# @option params [Integer] :max_results
|
9812
|
+
# The maximum number of results returned at one time.
|
9813
|
+
#
|
9814
|
+
# @option params [String] :next_token
|
9815
|
+
# The token for the next set of results.
|
9816
|
+
#
|
9817
|
+
# @return [Types::ListPackagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9818
|
+
#
|
9819
|
+
# * {Types::ListPackagesResponse#package_summaries #package_summaries} => Array<Types::PackageSummary>
|
9820
|
+
# * {Types::ListPackagesResponse#next_token #next_token} => String
|
9821
|
+
#
|
9822
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9823
|
+
#
|
9824
|
+
# @example Request syntax with placeholder values
|
9825
|
+
#
|
9826
|
+
# resp = client.list_packages({
|
9827
|
+
# max_results: 1,
|
9828
|
+
# next_token: "NextToken",
|
9829
|
+
# })
|
9830
|
+
#
|
9831
|
+
# @example Response structure
|
9832
|
+
#
|
9833
|
+
# resp.package_summaries #=> Array
|
9834
|
+
# resp.package_summaries[0].package_name #=> String
|
9835
|
+
# resp.package_summaries[0].default_version_name #=> String
|
9836
|
+
# resp.package_summaries[0].creation_date #=> Time
|
9837
|
+
# resp.package_summaries[0].last_modified_date #=> Time
|
9838
|
+
# resp.next_token #=> String
|
9839
|
+
#
|
9840
|
+
# @overload list_packages(params = {})
|
9841
|
+
# @param [Hash] params ({})
|
9842
|
+
def list_packages(params = {}, options = {})
|
9843
|
+
req = build_request(:list_packages, params)
|
9844
|
+
req.send_request(options)
|
9845
|
+
end
|
9846
|
+
|
8964
9847
|
# Lists your policies.
|
8965
9848
|
#
|
8966
9849
|
# Requires permission to access the [ListPolicies][1] action.
|
@@ -9010,8 +9893,9 @@ module Aws::IoT
|
|
9010
9893
|
|
9011
9894
|
# Lists the principals associated with the specified policy.
|
9012
9895
|
#
|
9013
|
-
# **Note:** This action is deprecated
|
9014
|
-
#
|
9896
|
+
# **Note:** This action is deprecated and works as expected for backward
|
9897
|
+
# compatibility, but we won't add enhancements. Use
|
9898
|
+
# ListTargetsForPolicy instead.
|
9015
9899
|
#
|
9016
9900
|
# Requires permission to access the [ListPolicyPrincipals][1] action.
|
9017
9901
|
#
|
@@ -9101,8 +9985,9 @@ module Aws::IoT
|
|
9101
9985
|
# Cognito identity, the ID must be in [AmazonCognito Identity
|
9102
9986
|
# format][1].
|
9103
9987
|
#
|
9104
|
-
# **Note:** This action is deprecated
|
9105
|
-
#
|
9988
|
+
# **Note:** This action is deprecated and works as expected for backward
|
9989
|
+
# compatibility, but we won't add enhancements. Use
|
9990
|
+
# ListAttachedPolicies instead.
|
9106
9991
|
#
|
9107
9992
|
# Requires permission to access the [ListPrincipalPolicies][2] action.
|
9108
9993
|
#
|
@@ -9113,10 +9998,9 @@ module Aws::IoT
|
|
9113
9998
|
#
|
9114
9999
|
# @option params [required, String] :principal
|
9115
10000
|
# The principal. Valid principals are CertificateArn
|
9116
|
-
# (arn:aws:iot:*region
|
9117
|
-
#
|
9118
|
-
# (
|
9119
|
-
# CognitoId (*region*\:*id*).
|
10001
|
+
# (arn:aws:iot:*region*:*accountId*:cert/*certificateId*), thingGroupArn
|
10002
|
+
# (arn:aws:iot:*region*:*accountId*:thinggroup/*groupName*) and
|
10003
|
+
# CognitoId (*region*:*id*).
|
9120
10004
|
#
|
9121
10005
|
# @option params [String] :marker
|
9122
10006
|
# The marker for the next set of results.
|
@@ -9207,7 +10091,7 @@ module Aws::IoT
|
|
9207
10091
|
req.send_request(options)
|
9208
10092
|
end
|
9209
10093
|
|
9210
|
-
# A list of
|
10094
|
+
# A list of provisioning template versions.
|
9211
10095
|
#
|
9212
10096
|
# Requires permission to access the
|
9213
10097
|
# [ListProvisioningTemplateVersions][1] action.
|
@@ -9217,7 +10101,7 @@ module Aws::IoT
|
|
9217
10101
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9218
10102
|
#
|
9219
10103
|
# @option params [required, String] :template_name
|
9220
|
-
# The name of the
|
10104
|
+
# The name of the provisioning template.
|
9221
10105
|
#
|
9222
10106
|
# @option params [Integer] :max_results
|
9223
10107
|
# The maximum number of results to return at one time.
|
@@ -9255,8 +10139,7 @@ module Aws::IoT
|
|
9255
10139
|
req.send_request(options)
|
9256
10140
|
end
|
9257
10141
|
|
9258
|
-
# Lists the
|
9259
|
-
# account.
|
10142
|
+
# Lists the provisioning templates in your Amazon Web Services account.
|
9260
10143
|
#
|
9261
10144
|
# Requires permission to access the [ListProvisioningTemplates][1]
|
9262
10145
|
# action.
|
@@ -9294,6 +10177,7 @@ module Aws::IoT
|
|
9294
10177
|
# resp.templates[0].creation_date #=> Time
|
9295
10178
|
# resp.templates[0].last_modified_date #=> Time
|
9296
10179
|
# resp.templates[0].enabled #=> Boolean
|
10180
|
+
# resp.templates[0].type #=> String, one of "FLEET_PROVISIONING", "JITP"
|
9297
10181
|
# resp.next_token #=> String
|
9298
10182
|
#
|
9299
10183
|
# @overload list_provisioning_templates(params = {})
|
@@ -9303,6 +10187,93 @@ module Aws::IoT
|
|
9303
10187
|
req.send_request(options)
|
9304
10188
|
end
|
9305
10189
|
|
10190
|
+
# The related resources of an Audit finding. The following resources can
|
10191
|
+
# be returned from calling this API:
|
10192
|
+
#
|
10193
|
+
# * DEVICE\_CERTIFICATE
|
10194
|
+
#
|
10195
|
+
# * CA\_CERTIFICATE
|
10196
|
+
#
|
10197
|
+
# * IOT\_POLICY
|
10198
|
+
#
|
10199
|
+
# * COGNITO\_IDENTITY\_POOL
|
10200
|
+
#
|
10201
|
+
# * CLIENT\_ID
|
10202
|
+
#
|
10203
|
+
# * ACCOUNT\_SETTINGS
|
10204
|
+
#
|
10205
|
+
# * ROLE\_ALIAS
|
10206
|
+
#
|
10207
|
+
# * IAM\_ROLE
|
10208
|
+
#
|
10209
|
+
# * ISSUER\_CERTIFICATE
|
10210
|
+
#
|
10211
|
+
# <note markdown="1"> This API is similar to DescribeAuditFinding's [RelatedResources][1]
|
10212
|
+
# but provides pagination and is not limited to 10 resources. When
|
10213
|
+
# calling [DescribeAuditFinding][1] for the intermediate CA revoked for
|
10214
|
+
# active device certificates check, RelatedResources will not be
|
10215
|
+
# populated. You must use this API, ListRelatedResourcesForAuditFinding,
|
10216
|
+
# to list the certificates.
|
10217
|
+
#
|
10218
|
+
# </note>
|
10219
|
+
#
|
10220
|
+
#
|
10221
|
+
#
|
10222
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html
|
10223
|
+
#
|
10224
|
+
# @option params [required, String] :finding_id
|
10225
|
+
# The finding Id.
|
10226
|
+
#
|
10227
|
+
# @option params [String] :next_token
|
10228
|
+
# A token that can be used to retrieve the next set of results, or
|
10229
|
+
# `null` if there are no additional results.
|
10230
|
+
#
|
10231
|
+
# @option params [Integer] :max_results
|
10232
|
+
# The maximum number of results to return at one time.
|
10233
|
+
#
|
10234
|
+
# @return [Types::ListRelatedResourcesForAuditFindingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10235
|
+
#
|
10236
|
+
# * {Types::ListRelatedResourcesForAuditFindingResponse#related_resources #related_resources} => Array<Types::RelatedResource>
|
10237
|
+
# * {Types::ListRelatedResourcesForAuditFindingResponse#next_token #next_token} => String
|
10238
|
+
#
|
10239
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
10240
|
+
#
|
10241
|
+
# @example Request syntax with placeholder values
|
10242
|
+
#
|
10243
|
+
# resp = client.list_related_resources_for_audit_finding({
|
10244
|
+
# finding_id: "FindingId", # required
|
10245
|
+
# next_token: "NextToken",
|
10246
|
+
# max_results: 1,
|
10247
|
+
# })
|
10248
|
+
#
|
10249
|
+
# @example Response structure
|
10250
|
+
#
|
10251
|
+
# resp.related_resources #=> Array
|
10252
|
+
# resp.related_resources[0].resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS", "ROLE_ALIAS", "IAM_ROLE", "ISSUER_CERTIFICATE"
|
10253
|
+
# resp.related_resources[0].resource_identifier.device_certificate_id #=> String
|
10254
|
+
# resp.related_resources[0].resource_identifier.ca_certificate_id #=> String
|
10255
|
+
# resp.related_resources[0].resource_identifier.cognito_identity_pool_id #=> String
|
10256
|
+
# resp.related_resources[0].resource_identifier.client_id #=> String
|
10257
|
+
# resp.related_resources[0].resource_identifier.policy_version_identifier.policy_name #=> String
|
10258
|
+
# resp.related_resources[0].resource_identifier.policy_version_identifier.policy_version_id #=> String
|
10259
|
+
# resp.related_resources[0].resource_identifier.account #=> String
|
10260
|
+
# resp.related_resources[0].resource_identifier.iam_role_arn #=> String
|
10261
|
+
# resp.related_resources[0].resource_identifier.role_alias_arn #=> String
|
10262
|
+
# resp.related_resources[0].resource_identifier.issuer_certificate_identifier.issuer_certificate_subject #=> String
|
10263
|
+
# resp.related_resources[0].resource_identifier.issuer_certificate_identifier.issuer_id #=> String
|
10264
|
+
# resp.related_resources[0].resource_identifier.issuer_certificate_identifier.issuer_certificate_serial_number #=> String
|
10265
|
+
# resp.related_resources[0].resource_identifier.device_certificate_arn #=> String
|
10266
|
+
# resp.related_resources[0].additional_info #=> Hash
|
10267
|
+
# resp.related_resources[0].additional_info["String"] #=> String
|
10268
|
+
# resp.next_token #=> String
|
10269
|
+
#
|
10270
|
+
# @overload list_related_resources_for_audit_finding(params = {})
|
10271
|
+
# @param [Hash] params ({})
|
10272
|
+
def list_related_resources_for_audit_finding(params = {}, options = {})
|
10273
|
+
req = build_request(:list_related_resources_for_audit_finding, params)
|
10274
|
+
req.send_request(options)
|
10275
|
+
end
|
10276
|
+
|
9306
10277
|
# Lists the role aliases registered in your account.
|
9307
10278
|
#
|
9308
10279
|
# Requires permission to access the [ListRoleAliases][1] action.
|
@@ -9996,9 +10967,10 @@ module Aws::IoT
|
|
9996
10967
|
# parameters to filter your things. For example, calling `ListThings`
|
9997
10968
|
# with attributeName=Color and attributeValue=Red retrieves all things
|
9998
10969
|
# in the registry that contain an attribute **Color** with the value
|
9999
|
-
# **Red**.
|
10970
|
+
# **Red**. For more information, see [List Things][1] from the *Amazon
|
10971
|
+
# Web Services IoT Core Developer Guide*.
|
10000
10972
|
#
|
10001
|
-
# Requires permission to access the [ListThings][
|
10973
|
+
# Requires permission to access the [ListThings][2] action.
|
10002
10974
|
#
|
10003
10975
|
# <note markdown="1"> You will not be charged for calling this API if an `Access denied`
|
10004
10976
|
# error is returned. You will also not be charged if no attributes or
|
@@ -10009,7 +10981,8 @@ module Aws::IoT
|
|
10009
10981
|
#
|
10010
10982
|
#
|
10011
10983
|
#
|
10012
|
-
# [1]: https://docs.aws.amazon.com/
|
10984
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html#list-things
|
10985
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10013
10986
|
#
|
10014
10987
|
# @option params [String] :next_token
|
10015
10988
|
# To retrieve the next set of results, the `nextToken` value from a
|
@@ -10313,7 +11286,7 @@ module Aws::IoT
|
|
10313
11286
|
# @example Request syntax with placeholder values
|
10314
11287
|
#
|
10315
11288
|
# resp = client.list_v2_logging_levels({
|
10316
|
-
# target_type: "DEFAULT", # accepts DEFAULT, THING_GROUP
|
11289
|
+
# target_type: "DEFAULT", # accepts DEFAULT, THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, EVENT_TYPE, DEVICE_DEFENDER
|
10317
11290
|
# next_token: "NextToken",
|
10318
11291
|
# max_results: 1,
|
10319
11292
|
# })
|
@@ -10321,7 +11294,7 @@ module Aws::IoT
|
|
10321
11294
|
# @example Response structure
|
10322
11295
|
#
|
10323
11296
|
# resp.log_target_configurations #=> Array
|
10324
|
-
# resp.log_target_configurations[0].log_target.target_type #=> String, one of "DEFAULT", "THING_GROUP"
|
11297
|
+
# 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"
|
10325
11298
|
# resp.log_target_configurations[0].log_target.target_name #=> String
|
10326
11299
|
# resp.log_target_configurations[0].log_level #=> String, one of "DEBUG", "INFO", "ERROR", "WARN", "DISABLED"
|
10327
11300
|
# resp.next_token #=> String
|
@@ -10475,14 +11448,10 @@ module Aws::IoT
|
|
10475
11448
|
req.send_request(options)
|
10476
11449
|
end
|
10477
11450
|
|
10478
|
-
# Registers a CA certificate with
|
10479
|
-
#
|
10480
|
-
#
|
10481
|
-
#
|
10482
|
-
# to 10 certificate authorities sign your device certificates. If you
|
10483
|
-
# have more than one CA certificate registered, make sure you pass the
|
10484
|
-
# CA certificate when you register your device certificates with the
|
10485
|
-
# RegisterCertificate action.
|
11451
|
+
# Registers a CA certificate with Amazon Web Services IoT Core. There is
|
11452
|
+
# no limit to the number of CA certificates you can register in your
|
11453
|
+
# Amazon Web Services account. You can register up to 10 CA certificates
|
11454
|
+
# with the same `CA subject field` per Amazon Web Services account.
|
10486
11455
|
#
|
10487
11456
|
# Requires permission to access the [RegisterCACertificate][1] action.
|
10488
11457
|
#
|
@@ -10493,12 +11462,17 @@ module Aws::IoT
|
|
10493
11462
|
# @option params [required, String] :ca_certificate
|
10494
11463
|
# The CA certificate.
|
10495
11464
|
#
|
10496
|
-
# @option params [
|
10497
|
-
# The private key verification certificate.
|
11465
|
+
# @option params [String] :verification_certificate
|
11466
|
+
# The private key verification certificate. If `certificateMode` is
|
11467
|
+
# `SNI_ONLY`, the `verificationCertificate` field must be empty. If
|
11468
|
+
# `certificateMode` is `DEFAULT` or not provided, the
|
11469
|
+
# `verificationCertificate` field must not be empty.
|
10498
11470
|
#
|
10499
11471
|
# @option params [Boolean] :set_as_active
|
10500
11472
|
# A boolean value that specifies if the CA certificate is set to active.
|
10501
11473
|
#
|
11474
|
+
# Valid values: `ACTIVE | INACTIVE`
|
11475
|
+
#
|
10502
11476
|
# @option params [Boolean] :allow_auto_registration
|
10503
11477
|
# Allows this CA certificate to be used for auto registration of device
|
10504
11478
|
# certificates.
|
@@ -10520,6 +11494,21 @@ module Aws::IoT
|
|
10520
11494
|
#
|
10521
11495
|
# </note>
|
10522
11496
|
#
|
11497
|
+
# @option params [String] :certificate_mode
|
11498
|
+
# Describes the certificate mode in which the Certificate Authority (CA)
|
11499
|
+
# will be registered. If the `verificationCertificate` field is not
|
11500
|
+
# provided, set `certificateMode` to be `SNI_ONLY`. If the
|
11501
|
+
# `verificationCertificate` field is provided, set `certificateMode` to
|
11502
|
+
# be `DEFAULT`. When `certificateMode` is not provided, it defaults to
|
11503
|
+
# `DEFAULT`. All the device certificates that are registered using this
|
11504
|
+
# CA will be registered in the same certificate mode as the CA. For more
|
11505
|
+
# information about certificate mode for device certificates, see [
|
11506
|
+
# certificate mode][1].
|
11507
|
+
#
|
11508
|
+
#
|
11509
|
+
#
|
11510
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode
|
11511
|
+
#
|
10523
11512
|
# @return [Types::RegisterCACertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10524
11513
|
#
|
10525
11514
|
# * {Types::RegisterCACertificateResponse#certificate_arn #certificate_arn} => String
|
@@ -10529,12 +11518,13 @@ module Aws::IoT
|
|
10529
11518
|
#
|
10530
11519
|
# resp = client.register_ca_certificate({
|
10531
11520
|
# ca_certificate: "CertificatePem", # required
|
10532
|
-
# verification_certificate: "CertificatePem",
|
11521
|
+
# verification_certificate: "CertificatePem",
|
10533
11522
|
# set_as_active: false,
|
10534
11523
|
# allow_auto_registration: false,
|
10535
11524
|
# registration_config: {
|
10536
11525
|
# template_body: "TemplateBody",
|
10537
11526
|
# role_arn: "RoleArn",
|
11527
|
+
# template_name: "TemplateName",
|
10538
11528
|
# },
|
10539
11529
|
# tags: [
|
10540
11530
|
# {
|
@@ -10542,6 +11532,7 @@ module Aws::IoT
|
|
10542
11532
|
# value: "TagValue",
|
10543
11533
|
# },
|
10544
11534
|
# ],
|
11535
|
+
# certificate_mode: "DEFAULT", # accepts DEFAULT, SNI_ONLY
|
10545
11536
|
# })
|
10546
11537
|
#
|
10547
11538
|
# @example Response structure
|
@@ -10556,16 +11547,17 @@ module Aws::IoT
|
|
10556
11547
|
req.send_request(options)
|
10557
11548
|
end
|
10558
11549
|
|
10559
|
-
# Registers a device certificate with IoT
|
10560
|
-
#
|
10561
|
-
#
|
10562
|
-
# registered.
|
11550
|
+
# Registers a device certificate with IoT in the same [certificate
|
11551
|
+
# mode][1] as the signing CA. If you have more than one CA certificate
|
11552
|
+
# that has the same subject field, you must specify the CA certificate
|
11553
|
+
# that was used to sign the device certificate being registered.
|
10563
11554
|
#
|
10564
|
-
# Requires permission to access the [RegisterCertificate][
|
11555
|
+
# Requires permission to access the [RegisterCertificate][2] action.
|
10565
11556
|
#
|
10566
11557
|
#
|
10567
11558
|
#
|
10568
|
-
# [1]: https://docs.aws.amazon.com/
|
11559
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode
|
11560
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10569
11561
|
#
|
10570
11562
|
# @option params [required, String] :certificate_pem
|
10571
11563
|
# The certificate data, in PEM format.
|
@@ -10577,8 +11569,11 @@ module Aws::IoT
|
|
10577
11569
|
# @option params [Boolean] :set_as_active
|
10578
11570
|
# A boolean value that specifies if the certificate is set to active.
|
10579
11571
|
#
|
11572
|
+
# Valid values: `ACTIVE | INACTIVE`
|
11573
|
+
#
|
10580
11574
|
# @option params [String] :status
|
10581
|
-
# The status of the register certificate request.
|
11575
|
+
# The status of the register certificate request. Valid values that you
|
11576
|
+
# can use include `ACTIVE`, `INACTIVE`, and `REVOKED`.
|
10582
11577
|
#
|
10583
11578
|
# @return [Types::RegisterCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10584
11579
|
#
|
@@ -10897,6 +11892,19 @@ module Aws::IoT
|
|
10897
11892
|
# role_arn: "AwsArn", # required
|
10898
11893
|
# topic: "TopicPattern", # required
|
10899
11894
|
# qos: 1,
|
11895
|
+
# headers: {
|
11896
|
+
# payload_format_indicator: "PayloadFormatIndicator",
|
11897
|
+
# content_type: "ContentType",
|
11898
|
+
# response_topic: "ResponseTopic",
|
11899
|
+
# correlation_data: "CorrelationData",
|
11900
|
+
# message_expiry: "MessageExpiry",
|
11901
|
+
# user_properties: [
|
11902
|
+
# {
|
11903
|
+
# key: "UserPropertyKey", # required
|
11904
|
+
# value: "UserPropertyValue", # required
|
11905
|
+
# },
|
11906
|
+
# ],
|
11907
|
+
# },
|
10900
11908
|
# },
|
10901
11909
|
# s3: {
|
10902
11910
|
# role_arn: "AwsArn", # required
|
@@ -10927,6 +11935,7 @@ module Aws::IoT
|
|
10927
11935
|
# cloudwatch_logs: {
|
10928
11936
|
# role_arn: "AwsArn", # required
|
10929
11937
|
# log_group_name: "LogGroupName", # required
|
11938
|
+
# batch_mode: false,
|
10930
11939
|
# },
|
10931
11940
|
# elasticsearch: {
|
10932
11941
|
# role_arn: "AwsArn", # required
|
@@ -11022,6 +12031,12 @@ module Aws::IoT
|
|
11022
12031
|
# client_properties: { # required
|
11023
12032
|
# "String" => "String",
|
11024
12033
|
# },
|
12034
|
+
# headers: [
|
12035
|
+
# {
|
12036
|
+
# key: "KafkaHeaderKey", # required
|
12037
|
+
# value: "KafkaHeaderValue", # required
|
12038
|
+
# },
|
12039
|
+
# ],
|
11025
12040
|
# },
|
11026
12041
|
# open_search: {
|
11027
12042
|
# role_arn: "AwsArn", # required
|
@@ -11030,6 +12045,17 @@ module Aws::IoT
|
|
11030
12045
|
# type: "ElasticsearchType", # required
|
11031
12046
|
# id: "ElasticsearchId", # required
|
11032
12047
|
# },
|
12048
|
+
# location: {
|
12049
|
+
# role_arn: "AwsArn", # required
|
12050
|
+
# tracker_name: "String", # required
|
12051
|
+
# device_id: "String", # required
|
12052
|
+
# timestamp: {
|
12053
|
+
# value: "String", # required
|
12054
|
+
# unit: "String",
|
12055
|
+
# },
|
12056
|
+
# latitude: "String", # required
|
12057
|
+
# longitude: "String", # required
|
12058
|
+
# },
|
11033
12059
|
# },
|
11034
12060
|
# ],
|
11035
12061
|
# rule_disabled: false,
|
@@ -11075,6 +12101,19 @@ module Aws::IoT
|
|
11075
12101
|
# role_arn: "AwsArn", # required
|
11076
12102
|
# topic: "TopicPattern", # required
|
11077
12103
|
# qos: 1,
|
12104
|
+
# headers: {
|
12105
|
+
# payload_format_indicator: "PayloadFormatIndicator",
|
12106
|
+
# content_type: "ContentType",
|
12107
|
+
# response_topic: "ResponseTopic",
|
12108
|
+
# correlation_data: "CorrelationData",
|
12109
|
+
# message_expiry: "MessageExpiry",
|
12110
|
+
# user_properties: [
|
12111
|
+
# {
|
12112
|
+
# key: "UserPropertyKey", # required
|
12113
|
+
# value: "UserPropertyValue", # required
|
12114
|
+
# },
|
12115
|
+
# ],
|
12116
|
+
# },
|
11078
12117
|
# },
|
11079
12118
|
# s3: {
|
11080
12119
|
# role_arn: "AwsArn", # required
|
@@ -11105,6 +12144,7 @@ module Aws::IoT
|
|
11105
12144
|
# cloudwatch_logs: {
|
11106
12145
|
# role_arn: "AwsArn", # required
|
11107
12146
|
# log_group_name: "LogGroupName", # required
|
12147
|
+
# batch_mode: false,
|
11108
12148
|
# },
|
11109
12149
|
# elasticsearch: {
|
11110
12150
|
# role_arn: "AwsArn", # required
|
@@ -11200,6 +12240,12 @@ module Aws::IoT
|
|
11200
12240
|
# client_properties: { # required
|
11201
12241
|
# "String" => "String",
|
11202
12242
|
# },
|
12243
|
+
# headers: [
|
12244
|
+
# {
|
12245
|
+
# key: "KafkaHeaderKey", # required
|
12246
|
+
# value: "KafkaHeaderValue", # required
|
12247
|
+
# },
|
12248
|
+
# ],
|
11203
12249
|
# },
|
11204
12250
|
# open_search: {
|
11205
12251
|
# role_arn: "AwsArn", # required
|
@@ -11208,6 +12254,17 @@ module Aws::IoT
|
|
11208
12254
|
# type: "ElasticsearchType", # required
|
11209
12255
|
# id: "ElasticsearchId", # required
|
11210
12256
|
# },
|
12257
|
+
# location: {
|
12258
|
+
# role_arn: "AwsArn", # required
|
12259
|
+
# tracker_name: "String", # required
|
12260
|
+
# device_id: "String", # required
|
12261
|
+
# timestamp: {
|
12262
|
+
# value: "String", # required
|
12263
|
+
# unit: "String",
|
12264
|
+
# },
|
12265
|
+
# latitude: "String", # required
|
12266
|
+
# longitude: "String", # required
|
12267
|
+
# },
|
11211
12268
|
# },
|
11212
12269
|
# },
|
11213
12270
|
# })
|
@@ -11231,7 +12288,12 @@ module Aws::IoT
|
|
11231
12288
|
# The search index name.
|
11232
12289
|
#
|
11233
12290
|
# @option params [required, String] :query_string
|
11234
|
-
# The search query string.
|
12291
|
+
# The search query string. For more information about the search query
|
12292
|
+
# syntax, see [Query syntax][1].
|
12293
|
+
#
|
12294
|
+
#
|
12295
|
+
#
|
12296
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html
|
11235
12297
|
#
|
11236
12298
|
# @option params [String] :next_token
|
11237
12299
|
# The token used to get the next set of results, or `null` if there are
|
@@ -11411,7 +12473,7 @@ module Aws::IoT
|
|
11411
12473
|
#
|
11412
12474
|
# resp = client.set_v2_logging_level({
|
11413
12475
|
# log_target: { # required
|
11414
|
-
# target_type: "DEFAULT", # required, accepts DEFAULT, THING_GROUP
|
12476
|
+
# target_type: "DEFAULT", # required, accepts DEFAULT, THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, EVENT_TYPE, DEVICE_DEFENDER
|
11415
12477
|
# target_name: "LogTargetName",
|
11416
12478
|
# },
|
11417
12479
|
# log_level: "DEBUG", # required, accepts DEBUG, INFO, ERROR, WARN, DISABLED
|
@@ -11751,10 +12813,9 @@ module Aws::IoT
|
|
11751
12813
|
#
|
11752
12814
|
# @option params [String] :principal
|
11753
12815
|
# The principal. Valid principals are CertificateArn
|
11754
|
-
# (arn:aws:iot:*region
|
11755
|
-
#
|
11756
|
-
# (
|
11757
|
-
# CognitoId (*region*\:*id*).
|
12816
|
+
# (arn:aws:iot:*region*:*accountId*:cert/*certificateId*), thingGroupArn
|
12817
|
+
# (arn:aws:iot:*region*:*accountId*:thinggroup/*groupName*) and
|
12818
|
+
# CognitoId (*region*:*id*).
|
11758
12819
|
#
|
11759
12820
|
# @option params [String] :cognito_identity_pool_id
|
11760
12821
|
# The Cognito identity pool ID.
|
@@ -12079,6 +13140,12 @@ module Aws::IoT
|
|
12079
13140
|
# account: "AwsAccountId",
|
12080
13141
|
# iam_role_arn: "RoleArn",
|
12081
13142
|
# role_alias_arn: "RoleAliasArn",
|
13143
|
+
# issuer_certificate_identifier: {
|
13144
|
+
# issuer_certificate_subject: "IssuerCertificateSubject",
|
13145
|
+
# issuer_id: "IssuerId",
|
13146
|
+
# issuer_certificate_serial_number: "IssuerCertificateSerialNumber",
|
13147
|
+
# },
|
13148
|
+
# device_certificate_arn: "CertificateArn",
|
12082
13149
|
# },
|
12083
13150
|
# expiration_date: Time.now,
|
12084
13151
|
# suppress_indefinitely: false,
|
@@ -12115,6 +13182,11 @@ module Aws::IoT
|
|
12115
13182
|
# @option params [String] :status
|
12116
13183
|
# The status of the update authorizer request.
|
12117
13184
|
#
|
13185
|
+
# @option params [Boolean] :enable_caching_for_http
|
13186
|
+
# When `true`, the result from the authorizer’s Lambda function is
|
13187
|
+
# cached for the time specified in `refreshAfterInSeconds`. The cached
|
13188
|
+
# result is used while the device reuses the same HTTP connection.
|
13189
|
+
#
|
12118
13190
|
# @return [Types::UpdateAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12119
13191
|
#
|
12120
13192
|
# * {Types::UpdateAuthorizerResponse#authorizer_name #authorizer_name} => String
|
@@ -12130,6 +13202,7 @@ module Aws::IoT
|
|
12130
13202
|
# "KeyName" => "KeyValue",
|
12131
13203
|
# },
|
12132
13204
|
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
13205
|
+
# enable_caching_for_http: false,
|
12133
13206
|
# })
|
12134
13207
|
#
|
12135
13208
|
# @example Response structure
|
@@ -12227,6 +13300,7 @@ module Aws::IoT
|
|
12227
13300
|
# registration_config: {
|
12228
13301
|
# template_body: "TemplateBody",
|
12229
13302
|
# role_arn: "RoleArn",
|
13303
|
+
# template_name: "TemplateName",
|
12230
13304
|
# },
|
12231
13305
|
# remove_auto_registration: false,
|
12232
13306
|
# })
|
@@ -12407,6 +13481,9 @@ module Aws::IoT
|
|
12407
13481
|
# @option params [Boolean] :remove_authorizer_config
|
12408
13482
|
# Removes the authorization configuration from a domain.
|
12409
13483
|
#
|
13484
|
+
# @option params [Types::TlsConfig] :tls_config
|
13485
|
+
# An object that specifies the TLS configuration for a domain.
|
13486
|
+
#
|
12410
13487
|
# @return [Types::UpdateDomainConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12411
13488
|
#
|
12412
13489
|
# * {Types::UpdateDomainConfigurationResponse#domain_configuration_name #domain_configuration_name} => String
|
@@ -12422,6 +13499,9 @@ module Aws::IoT
|
|
12422
13499
|
# },
|
12423
13500
|
# domain_configuration_status: "ENABLED", # accepts ENABLED, DISABLED
|
12424
13501
|
# remove_authorizer_config: false,
|
13502
|
+
# tls_config: {
|
13503
|
+
# security_policy: "SecurityPolicy",
|
13504
|
+
# },
|
12425
13505
|
# })
|
12426
13506
|
#
|
12427
13507
|
# @example Response structure
|
@@ -12644,6 +13724,9 @@ module Aws::IoT
|
|
12644
13724
|
# type: "Number", # accepts Number, String, Boolean
|
12645
13725
|
# },
|
12646
13726
|
# ],
|
13727
|
+
# filter: {
|
13728
|
+
# named_shadow_names: ["ShadowName"],
|
13729
|
+
# },
|
12647
13730
|
# },
|
12648
13731
|
# thing_group_indexing_configuration: {
|
12649
13732
|
# thing_group_indexing_mode: "OFF", # required, accepts OFF, ON
|
@@ -12712,6 +13795,9 @@ module Aws::IoT
|
|
12712
13795
|
#
|
12713
13796
|
# </note>
|
12714
13797
|
#
|
13798
|
+
# @option params [Types::JobExecutionsRetryConfig] :job_executions_retry_config
|
13799
|
+
# Allows you to create the criteria to retry a job.
|
13800
|
+
#
|
12715
13801
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
12716
13802
|
#
|
12717
13803
|
# @example Request syntax with placeholder values
|
@@ -12748,6 +13834,14 @@ module Aws::IoT
|
|
12748
13834
|
# in_progress_timeout_in_minutes: 1,
|
12749
13835
|
# },
|
12750
13836
|
# namespace_id: "NamespaceId",
|
13837
|
+
# job_executions_retry_config: {
|
13838
|
+
# criteria_list: [ # required
|
13839
|
+
# {
|
13840
|
+
# failure_type: "FAILED", # required, accepts FAILED, TIMED_OUT, ALL
|
13841
|
+
# number_of_retries: 1, # required
|
13842
|
+
# },
|
13843
|
+
# ],
|
13844
|
+
# },
|
12751
13845
|
# })
|
12752
13846
|
#
|
12753
13847
|
# @overload update_job(params = {})
|
@@ -12822,7 +13916,171 @@ module Aws::IoT
|
|
12822
13916
|
req.send_request(options)
|
12823
13917
|
end
|
12824
13918
|
|
12825
|
-
# Updates a
|
13919
|
+
# Updates the supported fields for a specific software package.
|
13920
|
+
#
|
13921
|
+
# Requires permission to access the [UpdatePackage][1] and
|
13922
|
+
# [GetIndexingConfiguration][1] actions.
|
13923
|
+
#
|
13924
|
+
#
|
13925
|
+
#
|
13926
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13927
|
+
#
|
13928
|
+
# @option params [required, String] :package_name
|
13929
|
+
# The name of the target software package.
|
13930
|
+
#
|
13931
|
+
# @option params [String] :description
|
13932
|
+
# The package description.
|
13933
|
+
#
|
13934
|
+
# @option params [String] :default_version_name
|
13935
|
+
# The name of the default package version.
|
13936
|
+
#
|
13937
|
+
# **Note:** You cannot name a `defaultVersion` and set
|
13938
|
+
# `unsetDefaultVersion` equal to `true` at the same time.
|
13939
|
+
#
|
13940
|
+
# @option params [Boolean] :unset_default_version
|
13941
|
+
# Indicates whether you want to remove the named default package version
|
13942
|
+
# from the software package. Set as `true` to remove the default package
|
13943
|
+
# version.
|
13944
|
+
#
|
13945
|
+
# **Note:** You cannot name a `defaultVersion` and set
|
13946
|
+
# `unsetDefaultVersion` equal to `true` at the same time.
|
13947
|
+
#
|
13948
|
+
# @option params [String] :client_token
|
13949
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
13950
|
+
# idempotency of the request. Don't reuse this client token if a new
|
13951
|
+
# idempotent request is required.
|
13952
|
+
#
|
13953
|
+
# **A suitable default value is auto-generated.** You should normally
|
13954
|
+
# not need to pass this option.**
|
13955
|
+
#
|
13956
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
13957
|
+
#
|
13958
|
+
# @example Request syntax with placeholder values
|
13959
|
+
#
|
13960
|
+
# resp = client.update_package({
|
13961
|
+
# package_name: "PackageName", # required
|
13962
|
+
# description: "ResourceDescription",
|
13963
|
+
# default_version_name: "VersionName",
|
13964
|
+
# unset_default_version: false,
|
13965
|
+
# client_token: "ClientToken",
|
13966
|
+
# })
|
13967
|
+
#
|
13968
|
+
# @overload update_package(params = {})
|
13969
|
+
# @param [Hash] params ({})
|
13970
|
+
def update_package(params = {}, options = {})
|
13971
|
+
req = build_request(:update_package, params)
|
13972
|
+
req.send_request(options)
|
13973
|
+
end
|
13974
|
+
|
13975
|
+
# Updates the software package configuration.
|
13976
|
+
#
|
13977
|
+
# Requires permission to access the [UpdatePackageConfiguration][1] and
|
13978
|
+
# [iam:PassRole][2] actions.
|
13979
|
+
#
|
13980
|
+
#
|
13981
|
+
#
|
13982
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13983
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html
|
13984
|
+
#
|
13985
|
+
# @option params [Types::VersionUpdateByJobsConfig] :version_update_by_jobs_config
|
13986
|
+
# Configuration to manage job's package version reporting. This updates
|
13987
|
+
# the thing's reserved named shadow that the job targets.
|
13988
|
+
#
|
13989
|
+
# @option params [String] :client_token
|
13990
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
13991
|
+
# idempotency of the request. Don't reuse this client token if a new
|
13992
|
+
# idempotent request is required.
|
13993
|
+
#
|
13994
|
+
# **A suitable default value is auto-generated.** You should normally
|
13995
|
+
# not need to pass this option.**
|
13996
|
+
#
|
13997
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
13998
|
+
#
|
13999
|
+
# @example Request syntax with placeholder values
|
14000
|
+
#
|
14001
|
+
# resp = client.update_package_configuration({
|
14002
|
+
# version_update_by_jobs_config: {
|
14003
|
+
# enabled: false,
|
14004
|
+
# role_arn: "RoleArn",
|
14005
|
+
# },
|
14006
|
+
# client_token: "ClientToken",
|
14007
|
+
# })
|
14008
|
+
#
|
14009
|
+
# @overload update_package_configuration(params = {})
|
14010
|
+
# @param [Hash] params ({})
|
14011
|
+
def update_package_configuration(params = {}, options = {})
|
14012
|
+
req = build_request(:update_package_configuration, params)
|
14013
|
+
req.send_request(options)
|
14014
|
+
end
|
14015
|
+
|
14016
|
+
# Updates the supported fields for a specific package version.
|
14017
|
+
#
|
14018
|
+
# Requires permission to access the [UpdatePackageVersion][1] and
|
14019
|
+
# [GetIndexingConfiguration][1] actions.
|
14020
|
+
#
|
14021
|
+
#
|
14022
|
+
#
|
14023
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
14024
|
+
#
|
14025
|
+
# @option params [required, String] :package_name
|
14026
|
+
# The name of the associated software package.
|
14027
|
+
#
|
14028
|
+
# @option params [required, String] :version_name
|
14029
|
+
# The name of the target package version.
|
14030
|
+
#
|
14031
|
+
# @option params [String] :description
|
14032
|
+
# The package version description.
|
14033
|
+
#
|
14034
|
+
# @option params [Hash<String,String>] :attributes
|
14035
|
+
# Metadata that can be used to define a package version’s configuration.
|
14036
|
+
# For example, the Amazon S3 file location, configuration options that
|
14037
|
+
# are being sent to the device or fleet.
|
14038
|
+
#
|
14039
|
+
# **Note:** Attributes can be updated only when the package version is
|
14040
|
+
# in a draft state.
|
14041
|
+
#
|
14042
|
+
# The combined size of all the attributes on a package version is
|
14043
|
+
# limited to 3KB.
|
14044
|
+
#
|
14045
|
+
# @option params [String] :action
|
14046
|
+
# The status that the package version should be assigned. For more
|
14047
|
+
# information, see [Package version lifecycle][1].
|
14048
|
+
#
|
14049
|
+
#
|
14050
|
+
#
|
14051
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
|
14052
|
+
#
|
14053
|
+
# @option params [String] :client_token
|
14054
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
14055
|
+
# idempotency of the request. Don't reuse this client token if a new
|
14056
|
+
# idempotent request is required.
|
14057
|
+
#
|
14058
|
+
# **A suitable default value is auto-generated.** You should normally
|
14059
|
+
# not need to pass this option.**
|
14060
|
+
#
|
14061
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
14062
|
+
#
|
14063
|
+
# @example Request syntax with placeholder values
|
14064
|
+
#
|
14065
|
+
# resp = client.update_package_version({
|
14066
|
+
# package_name: "PackageName", # required
|
14067
|
+
# version_name: "VersionName", # required
|
14068
|
+
# description: "ResourceDescription",
|
14069
|
+
# attributes: {
|
14070
|
+
# "ResourceAttributeKey" => "ResourceAttributeValue",
|
14071
|
+
# },
|
14072
|
+
# action: "PUBLISH", # accepts PUBLISH, DEPRECATE
|
14073
|
+
# client_token: "ClientToken",
|
14074
|
+
# })
|
14075
|
+
#
|
14076
|
+
# @overload update_package_version(params = {})
|
14077
|
+
# @param [Hash] params ({})
|
14078
|
+
def update_package_version(params = {}, options = {})
|
14079
|
+
req = build_request(:update_package_version, params)
|
14080
|
+
req.send_request(options)
|
14081
|
+
end
|
14082
|
+
|
14083
|
+
# Updates a provisioning template.
|
12826
14084
|
#
|
12827
14085
|
# Requires permission to access the [UpdateProvisioningTemplate][1]
|
12828
14086
|
# action.
|
@@ -12832,13 +14090,13 @@ module Aws::IoT
|
|
12832
14090
|
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12833
14091
|
#
|
12834
14092
|
# @option params [required, String] :template_name
|
12835
|
-
# The name of the
|
14093
|
+
# The name of the provisioning template.
|
12836
14094
|
#
|
12837
14095
|
# @option params [String] :description
|
12838
|
-
# The description of the
|
14096
|
+
# The description of the provisioning template.
|
12839
14097
|
#
|
12840
14098
|
# @option params [Boolean] :enabled
|
12841
|
-
# True to enable the
|
14099
|
+
# True to enable the provisioning template, otherwise false.
|
12842
14100
|
#
|
12843
14101
|
# @option params [Integer] :default_version_id
|
12844
14102
|
# The ID of the default provisioning template version.
|
@@ -12848,7 +14106,13 @@ module Aws::IoT
|
|
12848
14106
|
# IoT role grants permission to provision a device.
|
12849
14107
|
#
|
12850
14108
|
# @option params [Types::ProvisioningHook] :pre_provisioning_hook
|
12851
|
-
# Updates the pre-provisioning hook template.
|
14109
|
+
# Updates the pre-provisioning hook template. Only supports template of
|
14110
|
+
# type `FLEET_PROVISIONING`. For more information about provisioning
|
14111
|
+
# template types, see [type][1].
|
14112
|
+
#
|
14113
|
+
#
|
14114
|
+
#
|
14115
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_CreateProvisioningTemplate.html#iot-CreateProvisioningTemplate-request-type
|
12852
14116
|
#
|
12853
14117
|
# @option params [Boolean] :remove_pre_provisioning_hook
|
12854
14118
|
# Removes pre-provisioning hook template.
|
@@ -12894,6 +14158,9 @@ module Aws::IoT
|
|
12894
14158
|
# @option params [Integer] :credential_duration_seconds
|
12895
14159
|
# The number of seconds the credential will be valid.
|
12896
14160
|
#
|
14161
|
+
# This value must be less than or equal to the maximum session duration
|
14162
|
+
# of the IAM role that the role alias references.
|
14163
|
+
#
|
12897
14164
|
# @return [Types::UpdateRoleAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12898
14165
|
#
|
12899
14166
|
# * {Types::UpdateRoleAliasResponse#role_alias #role_alias} => String
|
@@ -13508,7 +14775,7 @@ module Aws::IoT
|
|
13508
14775
|
params: params,
|
13509
14776
|
config: config)
|
13510
14777
|
context[:gem_name] = 'aws-sdk-iot'
|
13511
|
-
context[:gem_version] = '1.
|
14778
|
+
context[:gem_version] = '1.111.0'
|
13512
14779
|
Seahorse::Client::Request.new(handlers, context)
|
13513
14780
|
end
|
13514
14781
|
|