aws-sdk-iot 1.89.0 → 1.92.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iot/client.rb +63 -21
- data/lib/aws-sdk-iot/client_api.rb +3 -1
- data/lib/aws-sdk-iot/types.rb +157 -9
- data/lib/aws-sdk-iot.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9283fd04d9f3c1ecfb6fe9139ca25d86936a6f2724869c0ba934661e67281260
|
4
|
+
data.tar.gz: 27a06475760c8cbad48c37bcd8cb48461e7897ac20aa014085caece4555d6eab
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d1bcdd45880e8c961cd8a1dad75898a06c426f14c8fc39fe301f95e354cd9f4c37eaf8a3fd0bc9196b722e320605033f49cb8c406494b3d6a551d3052221642b
|
7
|
+
data.tar.gz: cdfce80213ed22b13333c1c8d40d5a8eeaeb832708542783be02eee40b7f82aff58f865832c33ccfa1d9b9e6b10d92c094a1941b050d817fc9fd8b8d60fcdfe2
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.92.0 (2022-07-07)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds support to register a CA certificate without having to provide a verification certificate. This also allows multiple AWS accounts to register the same CA in the same region.
|
8
|
+
|
9
|
+
1.91.0 (2022-06-27)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release ease the restriction for the input of tag value to align with AWS standard, now instead of min length 1, we change it to min length 0.
|
13
|
+
|
14
|
+
1.90.0 (2022-05-12)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Documentation update for China region ListMetricValues for IoT
|
18
|
+
|
4
19
|
1.89.0 (2022-05-05)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.92.0
|
data/lib/aws-sdk-iot/client.rb
CHANGED
@@ -1716,6 +1716,13 @@ module Aws::IoT
|
|
1716
1716
|
# a thing when the thing is added to a target group, even after the job
|
1717
1717
|
# was completed by all things originally in the group.
|
1718
1718
|
#
|
1719
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs for
|
1720
|
+
# dynamic thing group targets. By using continuous jobs, devices that
|
1721
|
+
# join the group receive the job execution even after the job has been
|
1722
|
+
# created.
|
1723
|
+
#
|
1724
|
+
# </note>
|
1725
|
+
#
|
1719
1726
|
# @option params [Types::JobExecutionsRolloutConfig] :job_executions_rollout_config
|
1720
1727
|
# Allows you to create a staged rollout of the job.
|
1721
1728
|
#
|
@@ -1752,8 +1759,14 @@ module Aws::IoT
|
|
1752
1759
|
# Allows you to create the criteria to retry a job.
|
1753
1760
|
#
|
1754
1761
|
# @option params [Hash<String,String>] :document_parameters
|
1755
|
-
# Parameters of
|
1756
|
-
# job document.
|
1762
|
+
# Parameters of an Amazon Web Services managed template that you can
|
1763
|
+
# specify to create the job document.
|
1764
|
+
#
|
1765
|
+
# <note markdown="1"> `documentParameters` can only be used when creating jobs from Amazon
|
1766
|
+
# Web Services managed templates. This parameter can't be used with
|
1767
|
+
# custom job templates or to create jobs from them.
|
1768
|
+
#
|
1769
|
+
# </note>
|
1757
1770
|
#
|
1758
1771
|
# @return [Types::CreateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1759
1772
|
#
|
@@ -4984,6 +4997,7 @@ module Aws::IoT
|
|
4984
4997
|
# resp.certificate_description.generation_id #=> String
|
4985
4998
|
# resp.certificate_description.validity.not_before #=> Time
|
4986
4999
|
# resp.certificate_description.validity.not_after #=> Time
|
5000
|
+
# resp.certificate_description.certificate_mode #=> String, one of "DEFAULT", "SNI_ONLY"
|
4987
5001
|
# resp.registration_config.template_body #=> String
|
4988
5002
|
# resp.registration_config.role_arn #=> String
|
4989
5003
|
#
|
@@ -8770,6 +8784,13 @@ module Aws::IoT
|
|
8770
8784
|
# a thing when the thing is added to a target group, even after the job
|
8771
8785
|
# was completed by all things originally in the group.
|
8772
8786
|
#
|
8787
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs for
|
8788
|
+
# dynamic thing group targets. By using continuous jobs, devices that
|
8789
|
+
# join the group receive the job execution even after the job has been
|
8790
|
+
# created.
|
8791
|
+
#
|
8792
|
+
# </note>
|
8793
|
+
#
|
8773
8794
|
# @option params [Integer] :max_results
|
8774
8795
|
# The maximum number of results to return per request.
|
8775
8796
|
#
|
@@ -10616,14 +10637,10 @@ module Aws::IoT
|
|
10616
10637
|
req.send_request(options)
|
10617
10638
|
end
|
10618
10639
|
|
10619
|
-
# Registers a CA certificate with
|
10620
|
-
#
|
10621
|
-
#
|
10622
|
-
#
|
10623
|
-
# to 10 certificate authorities sign your device certificates. If you
|
10624
|
-
# have more than one CA certificate registered, make sure you pass the
|
10625
|
-
# CA certificate when you register your device certificates with the
|
10626
|
-
# RegisterCertificate action.
|
10640
|
+
# Registers a CA certificate with Amazon Web Services IoT Core. There is
|
10641
|
+
# no limit to the number of CA certificates you can register in your
|
10642
|
+
# Amazon Web Services account. You can register up to 10 CA certificates
|
10643
|
+
# with the same `CA subject field` per Amazon Web Services account.
|
10627
10644
|
#
|
10628
10645
|
# Requires permission to access the [RegisterCACertificate][1] action.
|
10629
10646
|
#
|
@@ -10634,8 +10651,11 @@ module Aws::IoT
|
|
10634
10651
|
# @option params [required, String] :ca_certificate
|
10635
10652
|
# The CA certificate.
|
10636
10653
|
#
|
10637
|
-
# @option params [
|
10638
|
-
# The private key verification certificate.
|
10654
|
+
# @option params [String] :verification_certificate
|
10655
|
+
# The private key verification certificate. If `certificateMode` is
|
10656
|
+
# `SNI_ONLY`, the `verificationCertificate` field must be empty. If
|
10657
|
+
# `certificateMode` is `DEFAULT` or not provided, the
|
10658
|
+
# `verificationCertificate` field must not be empty.
|
10639
10659
|
#
|
10640
10660
|
# @option params [Boolean] :set_as_active
|
10641
10661
|
# A boolean value that specifies if the CA certificate is set to active.
|
@@ -10663,6 +10683,21 @@ module Aws::IoT
|
|
10663
10683
|
#
|
10664
10684
|
# </note>
|
10665
10685
|
#
|
10686
|
+
# @option params [String] :certificate_mode
|
10687
|
+
# Describes the certificate mode in which the Certificate Authority (CA)
|
10688
|
+
# will be registered. If the `verificationCertificate` field is not
|
10689
|
+
# provided, set `certificateMode` to be `SNI_ONLY`. If the
|
10690
|
+
# `verificationCertificate` field is provided, set `certificateMode` to
|
10691
|
+
# be `DEFAULT`. When `certificateMode` is not provided, it defaults to
|
10692
|
+
# `DEFAULT`. All the device certificates that are registered using this
|
10693
|
+
# CA will be registered in the same certificate mode as the CA. For more
|
10694
|
+
# information about certificate mode for device certificates, see [
|
10695
|
+
# certificate mode][1].
|
10696
|
+
#
|
10697
|
+
#
|
10698
|
+
#
|
10699
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode
|
10700
|
+
#
|
10666
10701
|
# @return [Types::RegisterCACertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10667
10702
|
#
|
10668
10703
|
# * {Types::RegisterCACertificateResponse#certificate_arn #certificate_arn} => String
|
@@ -10672,7 +10707,7 @@ module Aws::IoT
|
|
10672
10707
|
#
|
10673
10708
|
# resp = client.register_ca_certificate({
|
10674
10709
|
# ca_certificate: "CertificatePem", # required
|
10675
|
-
# verification_certificate: "CertificatePem",
|
10710
|
+
# verification_certificate: "CertificatePem",
|
10676
10711
|
# set_as_active: false,
|
10677
10712
|
# allow_auto_registration: false,
|
10678
10713
|
# registration_config: {
|
@@ -10685,6 +10720,7 @@ module Aws::IoT
|
|
10685
10720
|
# value: "TagValue",
|
10686
10721
|
# },
|
10687
10722
|
# ],
|
10723
|
+
# certificate_mode: "DEFAULT", # accepts DEFAULT, SNI_ONLY
|
10688
10724
|
# })
|
10689
10725
|
#
|
10690
10726
|
# @example Response structure
|
@@ -10699,16 +10735,17 @@ module Aws::IoT
|
|
10699
10735
|
req.send_request(options)
|
10700
10736
|
end
|
10701
10737
|
|
10702
|
-
# Registers a device certificate with IoT
|
10703
|
-
#
|
10704
|
-
#
|
10705
|
-
# registered.
|
10738
|
+
# Registers a device certificate with IoT in the same [certificate
|
10739
|
+
# mode][1] as the signing CA. If you have more than one CA certificate
|
10740
|
+
# that has the same subject field, you must specify the CA certificate
|
10741
|
+
# that was used to sign the device certificate being registered.
|
10706
10742
|
#
|
10707
|
-
# Requires permission to access the [RegisterCertificate][
|
10743
|
+
# Requires permission to access the [RegisterCertificate][2] action.
|
10708
10744
|
#
|
10709
10745
|
#
|
10710
10746
|
#
|
10711
|
-
# [1]: https://docs.aws.amazon.com/
|
10747
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode
|
10748
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10712
10749
|
#
|
10713
10750
|
# @option params [required, String] :certificate_pem
|
10714
10751
|
# The certificate data, in PEM format.
|
@@ -11377,7 +11414,12 @@ module Aws::IoT
|
|
11377
11414
|
# The search index name.
|
11378
11415
|
#
|
11379
11416
|
# @option params [required, String] :query_string
|
11380
|
-
# The search query string.
|
11417
|
+
# The search query string. For more information about the search query
|
11418
|
+
# syntax, see [Query syntax][1].
|
11419
|
+
#
|
11420
|
+
#
|
11421
|
+
#
|
11422
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html
|
11381
11423
|
#
|
11382
11424
|
# @option params [String] :next_token
|
11383
11425
|
# The token used to get the next set of results, or `null` if there are
|
@@ -13674,7 +13716,7 @@ module Aws::IoT
|
|
13674
13716
|
params: params,
|
13675
13717
|
config: config)
|
13676
13718
|
context[:gem_name] = 'aws-sdk-iot'
|
13677
|
-
context[:gem_version] = '1.
|
13719
|
+
context[:gem_version] = '1.92.0'
|
13678
13720
|
Seahorse::Client::Request.new(handlers, context)
|
13679
13721
|
end
|
13680
13722
|
|
@@ -1641,6 +1641,7 @@ module Aws::IoT
|
|
1641
1641
|
CACertificateDescription.add_member(:customer_version, Shapes::ShapeRef.new(shape: CustomerVersion, location_name: "customerVersion"))
|
1642
1642
|
CACertificateDescription.add_member(:generation_id, Shapes::ShapeRef.new(shape: GenerationId, location_name: "generationId"))
|
1643
1643
|
CACertificateDescription.add_member(:validity, Shapes::ShapeRef.new(shape: CertificateValidity, location_name: "validity"))
|
1644
|
+
CACertificateDescription.add_member(:certificate_mode, Shapes::ShapeRef.new(shape: CertificateMode, location_name: "certificateMode"))
|
1644
1645
|
CACertificateDescription.struct_class = Types::CACertificateDescription
|
1645
1646
|
|
1646
1647
|
CACertificates.member = Shapes::ShapeRef.new(shape: CACertificate)
|
@@ -3926,11 +3927,12 @@ module Aws::IoT
|
|
3926
3927
|
ReasonForNonComplianceCodes.member = Shapes::ShapeRef.new(shape: ReasonForNonComplianceCode)
|
3927
3928
|
|
3928
3929
|
RegisterCACertificateRequest.add_member(:ca_certificate, Shapes::ShapeRef.new(shape: CertificatePem, required: true, location_name: "caCertificate"))
|
3929
|
-
RegisterCACertificateRequest.add_member(:verification_certificate, Shapes::ShapeRef.new(shape: CertificatePem,
|
3930
|
+
RegisterCACertificateRequest.add_member(:verification_certificate, Shapes::ShapeRef.new(shape: CertificatePem, location_name: "verificationCertificate"))
|
3930
3931
|
RegisterCACertificateRequest.add_member(:set_as_active, Shapes::ShapeRef.new(shape: SetAsActive, location: "querystring", location_name: "setAsActive"))
|
3931
3932
|
RegisterCACertificateRequest.add_member(:allow_auto_registration, Shapes::ShapeRef.new(shape: AllowAutoRegistration, location: "querystring", location_name: "allowAutoRegistration"))
|
3932
3933
|
RegisterCACertificateRequest.add_member(:registration_config, Shapes::ShapeRef.new(shape: RegistrationConfig, location_name: "registrationConfig"))
|
3933
3934
|
RegisterCACertificateRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
|
3935
|
+
RegisterCACertificateRequest.add_member(:certificate_mode, Shapes::ShapeRef.new(shape: CertificateMode, location_name: "certificateMode"))
|
3934
3936
|
RegisterCACertificateRequest.struct_class = Types::RegisterCACertificateRequest
|
3935
3937
|
|
3936
3938
|
RegisterCACertificateResponse.add_member(:certificate_arn, Shapes::ShapeRef.new(shape: CertificateArn, location_name: "certificateArn"))
|
data/lib/aws-sdk-iot/types.rb
CHANGED
@@ -2067,6 +2067,18 @@ module Aws::IoT
|
|
2067
2067
|
# When the CA certificate is valid.
|
2068
2068
|
# @return [Types::CertificateValidity]
|
2069
2069
|
#
|
2070
|
+
# @!attribute [rw] certificate_mode
|
2071
|
+
# The mode of the CA.
|
2072
|
+
#
|
2073
|
+
# All the device certificates that are registered using this CA will
|
2074
|
+
# be registered in the same mode as the CA. For more information about
|
2075
|
+
# certificate mode for device certificates, see [certificate mode][1].
|
2076
|
+
#
|
2077
|
+
#
|
2078
|
+
#
|
2079
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode
|
2080
|
+
# @return [String]
|
2081
|
+
#
|
2070
2082
|
class CACertificateDescription < Struct.new(
|
2071
2083
|
:certificate_arn,
|
2072
2084
|
:certificate_id,
|
@@ -2078,7 +2090,8 @@ module Aws::IoT
|
|
2078
2090
|
:last_modified_date,
|
2079
2091
|
:customer_version,
|
2080
2092
|
:generation_id,
|
2081
|
-
:validity
|
2093
|
+
:validity,
|
2094
|
+
:certificate_mode)
|
2082
2095
|
SENSITIVE = []
|
2083
2096
|
include Aws::Structure
|
2084
2097
|
end
|
@@ -2305,6 +2318,19 @@ module Aws::IoT
|
|
2305
2318
|
#
|
2306
2319
|
# @!attribute [rw] certificate_mode
|
2307
2320
|
# The mode of the certificate.
|
2321
|
+
#
|
2322
|
+
# `DEFAULT`\: A certificate in `DEFAULT` mode is either generated by
|
2323
|
+
# Amazon Web Services IoT Core or registered with an issuer
|
2324
|
+
# certificate authority (CA) in `DEFAULT` mode. Devices with
|
2325
|
+
# certificates in `DEFAULT` mode aren't required to send the Server
|
2326
|
+
# Name Indication (SNI) extension when connecting to Amazon Web
|
2327
|
+
# Services IoT Core. However, to use features such as custom domains
|
2328
|
+
# and VPC endpoints, we recommend that you use the SNI extension when
|
2329
|
+
# connecting to Amazon Web Services IoT Core.
|
2330
|
+
#
|
2331
|
+
# `SNI_ONLY`\: A certificate in `SNI_ONLY` mode is registered without
|
2332
|
+
# an issuer CA. Devices with certificates in `SNI_ONLY` mode must send
|
2333
|
+
# the SNI extension when connecting to Amazon Web Services IoT Core.
|
2308
2334
|
# @return [String]
|
2309
2335
|
#
|
2310
2336
|
# @!attribute [rw] creation_date
|
@@ -2394,6 +2420,26 @@ module Aws::IoT
|
|
2394
2420
|
#
|
2395
2421
|
# @!attribute [rw] certificate_mode
|
2396
2422
|
# The mode of the certificate.
|
2423
|
+
#
|
2424
|
+
# `DEFAULT`\: A certificate in `DEFAULT` mode is either generated by
|
2425
|
+
# Amazon Web Services IoT Core or registered with an issuer
|
2426
|
+
# certificate authority (CA) in `DEFAULT` mode. Devices with
|
2427
|
+
# certificates in `DEFAULT` mode aren't required to send the Server
|
2428
|
+
# Name Indication (SNI) extension when connecting to Amazon Web
|
2429
|
+
# Services IoT Core. However, to use features such as custom domains
|
2430
|
+
# and VPC endpoints, we recommend that you use the SNI extension when
|
2431
|
+
# connecting to Amazon Web Services IoT Core.
|
2432
|
+
#
|
2433
|
+
# `SNI_ONLY`\: A certificate in `SNI_ONLY` mode is registered without
|
2434
|
+
# an issuer CA. Devices with certificates in `SNI_ONLY` mode must send
|
2435
|
+
# the SNI extension when connecting to Amazon Web Services IoT Core.
|
2436
|
+
#
|
2437
|
+
# For more information about the value for SNI extension, see
|
2438
|
+
# [Transport security in IoT][1].
|
2439
|
+
#
|
2440
|
+
#
|
2441
|
+
#
|
2442
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html
|
2397
2443
|
# @return [String]
|
2398
2444
|
#
|
2399
2445
|
class CertificateDescription < Struct.new(
|
@@ -3588,6 +3634,13 @@ module Aws::IoT
|
|
3588
3634
|
# on a thing when a change is detected in a target. For example, a job
|
3589
3635
|
# will run on a thing when the thing is added to a target group, even
|
3590
3636
|
# after the job was completed by all things originally in the group.
|
3637
|
+
#
|
3638
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs
|
3639
|
+
# for dynamic thing group targets. By using continuous jobs, devices
|
3640
|
+
# that join the group receive the job execution even after the job has
|
3641
|
+
# been created.
|
3642
|
+
#
|
3643
|
+
# </note>
|
3591
3644
|
# @return [String]
|
3592
3645
|
#
|
3593
3646
|
# @!attribute [rw] job_executions_rollout_config
|
@@ -3633,8 +3686,14 @@ module Aws::IoT
|
|
3633
3686
|
# @return [Types::JobExecutionsRetryConfig]
|
3634
3687
|
#
|
3635
3688
|
# @!attribute [rw] document_parameters
|
3636
|
-
# Parameters of
|
3637
|
-
# job document.
|
3689
|
+
# Parameters of an Amazon Web Services managed template that you can
|
3690
|
+
# specify to create the job document.
|
3691
|
+
#
|
3692
|
+
# <note markdown="1"> `documentParameters` can only be used when creating jobs from Amazon
|
3693
|
+
# Web Services managed templates. This parameter can't be used with
|
3694
|
+
# custom job templates or to create jobs from them.
|
3695
|
+
#
|
3696
|
+
# </note>
|
3638
3697
|
# @return [Hash<String,String>]
|
3639
3698
|
#
|
3640
3699
|
class CreateJobRequest < Struct.new(
|
@@ -5517,11 +5576,21 @@ module Aws::IoT
|
|
5517
5576
|
# @return [Types::CodeSigningCertificateChain]
|
5518
5577
|
#
|
5519
5578
|
# @!attribute [rw] hash_algorithm
|
5520
|
-
# The hash algorithm used to code sign the file.
|
5579
|
+
# The hash algorithm used to code sign the file. You can use a string
|
5580
|
+
# as the algorithm name if the target over-the-air (OTA) update
|
5581
|
+
# devices are able to verify the signature that was generated using
|
5582
|
+
# the same signature algorithm. For example, FreeRTOS uses `SHA256` or
|
5583
|
+
# `SHA1`, so you can pass either of them based on which was used for
|
5584
|
+
# generating the signature.
|
5521
5585
|
# @return [String]
|
5522
5586
|
#
|
5523
5587
|
# @!attribute [rw] signature_algorithm
|
5524
|
-
# The signature algorithm used to code sign the file.
|
5588
|
+
# The signature algorithm used to code sign the file. You can use a
|
5589
|
+
# string as the algorithm name if the target over-the-air (OTA) update
|
5590
|
+
# devices are able to verify the signature that was generated using
|
5591
|
+
# the same signature algorithm. For example, FreeRTOS uses `ECDSA` or
|
5592
|
+
# `RSA`, so you can pass either of them based on which was used for
|
5593
|
+
# generating the signature.
|
5525
5594
|
# @return [String]
|
5526
5595
|
#
|
5527
5596
|
class CustomCodeSigning < Struct.new(
|
@@ -7429,6 +7498,12 @@ module Aws::IoT
|
|
7429
7498
|
# @!attribute [rw] document_parameters
|
7430
7499
|
# A map of key-value pairs that you can use as guidance to specify the
|
7431
7500
|
# inputs for creating a job from a managed template.
|
7501
|
+
#
|
7502
|
+
# <note markdown="1"> `documentParameters` can only be used when creating jobs from Amazon
|
7503
|
+
# Web Services managed templates. This parameter can't be used with
|
7504
|
+
# custom job templates or to create jobs from them.
|
7505
|
+
#
|
7506
|
+
# </note>
|
7432
7507
|
# @return [Array<Types::DocumentParameter>]
|
7433
7508
|
#
|
7434
7509
|
# @!attribute [rw] document
|
@@ -8446,6 +8521,12 @@ module Aws::IoT
|
|
8446
8521
|
# description of each key as a guidance to specify the inputs during
|
8447
8522
|
# runtime when creating a job.
|
8448
8523
|
#
|
8524
|
+
# <note markdown="1"> `documentParameters` can only be used when creating jobs from Amazon
|
8525
|
+
# Web Services managed templates. This parameter can't be used with
|
8526
|
+
# custom job templates or to create jobs from them.
|
8527
|
+
#
|
8528
|
+
# </note>
|
8529
|
+
#
|
8449
8530
|
# @!attribute [rw] key
|
8450
8531
|
# Key of the map field containing the patterns that need to be
|
8451
8532
|
# replaced in a managed template job document schema.
|
@@ -10095,6 +10176,13 @@ module Aws::IoT
|
|
10095
10176
|
# will run on a device when the thing representing the device is added
|
10096
10177
|
# to a target group, even after the job was completed by all things
|
10097
10178
|
# originally in the group.
|
10179
|
+
#
|
10180
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs
|
10181
|
+
# for dynamic thing group targets. By using continuous jobs, devices
|
10182
|
+
# that join the group receive the job execution even after the job has
|
10183
|
+
# been created.
|
10184
|
+
#
|
10185
|
+
# </note>
|
10098
10186
|
# @return [String]
|
10099
10187
|
#
|
10100
10188
|
# @!attribute [rw] status
|
@@ -10187,9 +10275,18 @@ module Aws::IoT
|
|
10187
10275
|
# a managed template job document schema. You can use the description
|
10188
10276
|
# of each key as a guidance to specify the inputs during runtime when
|
10189
10277
|
# creating a job.
|
10278
|
+
#
|
10279
|
+
# <note markdown="1"> `documentParameters` can only be used when creating jobs from Amazon
|
10280
|
+
# Web Services managed templates. This parameter can't be used with
|
10281
|
+
# custom job templates or to create jobs from them.
|
10282
|
+
#
|
10283
|
+
# </note>
|
10190
10284
|
# @return [Hash<String,String>]
|
10191
10285
|
#
|
10192
10286
|
# @!attribute [rw] is_concurrent
|
10287
|
+
# Indicates whether a job is concurrent. Will be true when a job is
|
10288
|
+
# rolling out new job executions or canceling previously created
|
10289
|
+
# executions, otherwise false.
|
10193
10290
|
# @return [Boolean]
|
10194
10291
|
#
|
10195
10292
|
class Job < Struct.new(
|
@@ -10525,6 +10622,13 @@ module Aws::IoT
|
|
10525
10622
|
# on a thing when a change is detected in a target. For example, a job
|
10526
10623
|
# will run on a thing when the thing is added to a target group, even
|
10527
10624
|
# after the job was completed by all things originally in the group.
|
10625
|
+
#
|
10626
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs
|
10627
|
+
# for dynamic thing group targets. By using continuous jobs, devices
|
10628
|
+
# that join the group receive the job execution even after the job has
|
10629
|
+
# been created.
|
10630
|
+
#
|
10631
|
+
# </note>
|
10528
10632
|
# @return [String]
|
10529
10633
|
#
|
10530
10634
|
# @!attribute [rw] status
|
@@ -10544,6 +10648,9 @@ module Aws::IoT
|
|
10544
10648
|
# @return [Time]
|
10545
10649
|
#
|
10546
10650
|
# @!attribute [rw] is_concurrent
|
10651
|
+
# Indicates whether a job is concurrent. Will be true when a job is
|
10652
|
+
# rolling out new job executions or canceling previously created
|
10653
|
+
# executions, otherwise false.
|
10547
10654
|
# @return [Boolean]
|
10548
10655
|
#
|
10549
10656
|
class JobSummary < Struct.new(
|
@@ -11998,6 +12105,13 @@ module Aws::IoT
|
|
11998
12105
|
# on a thing when a change is detected in a target. For example, a job
|
11999
12106
|
# will run on a thing when the thing is added to a target group, even
|
12000
12107
|
# after the job was completed by all things originally in the group.
|
12108
|
+
#
|
12109
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs
|
12110
|
+
# for dynamic thing group targets. By using continuous jobs, devices
|
12111
|
+
# that join the group receive the job execution even after the job has
|
12112
|
+
# been created.
|
12113
|
+
#
|
12114
|
+
# </note>
|
12001
12115
|
# @return [String]
|
12002
12116
|
#
|
12003
12117
|
# @!attribute [rw] max_results
|
@@ -14571,6 +14685,14 @@ module Aws::IoT
|
|
14571
14685
|
# The ARN of an IAM role that grants grants permission to download
|
14572
14686
|
# files from the S3 bucket where the job data/updates are stored. The
|
14573
14687
|
# role must also grant permission for IoT to download the files.
|
14688
|
+
#
|
14689
|
+
# For information about addressing the confused deputy problem, see
|
14690
|
+
# [cross-service confused deputy prevention][1] in the *Amazon Web
|
14691
|
+
# Services IoT Core developer guide*.
|
14692
|
+
#
|
14693
|
+
#
|
14694
|
+
#
|
14695
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html
|
14574
14696
|
# @return [String]
|
14575
14697
|
#
|
14576
14698
|
# @!attribute [rw] expires_in_sec
|
@@ -14850,7 +14972,7 @@ module Aws::IoT
|
|
14850
14972
|
#
|
14851
14973
|
# {
|
14852
14974
|
# ca_certificate: "CertificatePem", # required
|
14853
|
-
# verification_certificate: "CertificatePem",
|
14975
|
+
# verification_certificate: "CertificatePem",
|
14854
14976
|
# set_as_active: false,
|
14855
14977
|
# allow_auto_registration: false,
|
14856
14978
|
# registration_config: {
|
@@ -14863,6 +14985,7 @@ module Aws::IoT
|
|
14863
14985
|
# value: "TagValue",
|
14864
14986
|
# },
|
14865
14987
|
# ],
|
14988
|
+
# certificate_mode: "DEFAULT", # accepts DEFAULT, SNI_ONLY
|
14866
14989
|
# }
|
14867
14990
|
#
|
14868
14991
|
# @!attribute [rw] ca_certificate
|
@@ -14870,7 +14993,10 @@ module Aws::IoT
|
|
14870
14993
|
# @return [String]
|
14871
14994
|
#
|
14872
14995
|
# @!attribute [rw] verification_certificate
|
14873
|
-
# The private key verification certificate.
|
14996
|
+
# The private key verification certificate. If `certificateMode` is
|
14997
|
+
# `SNI_ONLY`, the `verificationCertificate` field must be empty. If
|
14998
|
+
# `certificateMode` is `DEFAULT` or not provided, the
|
14999
|
+
# `verificationCertificate` field must not be empty.
|
14874
15000
|
# @return [String]
|
14875
15001
|
#
|
14876
15002
|
# @!attribute [rw] set_as_active
|
@@ -14904,13 +15030,30 @@ module Aws::IoT
|
|
14904
15030
|
# </note>
|
14905
15031
|
# @return [Array<Types::Tag>]
|
14906
15032
|
#
|
15033
|
+
# @!attribute [rw] certificate_mode
|
15034
|
+
# Describes the certificate mode in which the Certificate Authority
|
15035
|
+
# (CA) will be registered. If the `verificationCertificate` field is
|
15036
|
+
# not provided, set `certificateMode` to be `SNI_ONLY`. If the
|
15037
|
+
# `verificationCertificate` field is provided, set `certificateMode`
|
15038
|
+
# to be `DEFAULT`. When `certificateMode` is not provided, it defaults
|
15039
|
+
# to `DEFAULT`. All the device certificates that are registered using
|
15040
|
+
# this CA will be registered in the same certificate mode as the CA.
|
15041
|
+
# For more information about certificate mode for device certificates,
|
15042
|
+
# see [ certificate mode][1].
|
15043
|
+
#
|
15044
|
+
#
|
15045
|
+
#
|
15046
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode
|
15047
|
+
# @return [String]
|
15048
|
+
#
|
14907
15049
|
class RegisterCACertificateRequest < Struct.new(
|
14908
15050
|
:ca_certificate,
|
14909
15051
|
:verification_certificate,
|
14910
15052
|
:set_as_active,
|
14911
15053
|
:allow_auto_registration,
|
14912
15054
|
:registration_config,
|
14913
|
-
:tags
|
15055
|
+
:tags,
|
15056
|
+
:certificate_mode)
|
14914
15057
|
SENSITIVE = []
|
14915
15058
|
include Aws::Structure
|
14916
15059
|
end
|
@@ -16037,7 +16180,12 @@ module Aws::IoT
|
|
16037
16180
|
# @return [String]
|
16038
16181
|
#
|
16039
16182
|
# @!attribute [rw] query_string
|
16040
|
-
# The search query string.
|
16183
|
+
# The search query string. For more information about the search query
|
16184
|
+
# syntax, see [Query syntax][1].
|
16185
|
+
#
|
16186
|
+
#
|
16187
|
+
#
|
16188
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html
|
16041
16189
|
# @return [String]
|
16042
16190
|
#
|
16043
16191
|
# @!attribute [rw] next_token
|
data/lib/aws-sdk-iot.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-iot
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.92.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-07-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|