aws-sdk-iot 1.57.0 → 1.62.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-iot.rb +1 -1
- data/lib/aws-sdk-iot/client.rb +260 -24
- data/lib/aws-sdk-iot/client_api.rb +57 -0
- data/lib/aws-sdk-iot/types.rb +585 -70
- metadata +4 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c1aa99b717792df7eb4907234c70da8bcc5fd8f6566e6c76342c7cb8a79b2ddd
|
|
4
|
+
data.tar.gz: 2c479f0968b20bd7034f7d2efbcb8aab4a509fa61071b9b9725b30c0a7d923b9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b9cbb208052356cd233d42c011907caaa8fdb911e3a5efe383a9b950d09da873db927fb8fd4ee0de8f98ba16c4ab20a3156d33a5aef6c97130b3d8d0c1ed9d22
|
|
7
|
+
data.tar.gz: 6768a64bd0682db23d4bb0b8365a8e584f4a873697905f8c6c32a13e7f2f0b01dd7f3defbb8f4ab56a753624069151a8906847cf39f52ba4a93821bd9f69dd6d
|
data/lib/aws-sdk-iot.rb
CHANGED
data/lib/aws-sdk-iot/client.rb
CHANGED
|
@@ -448,6 +448,19 @@ module Aws::IoT
|
|
|
448
448
|
# An optional comment string describing why the job was associated with
|
|
449
449
|
# the targets.
|
|
450
450
|
#
|
|
451
|
+
# @option params [String] :namespace_id
|
|
452
|
+
# The namespace used to indicate that a job is a customer-managed job.
|
|
453
|
+
#
|
|
454
|
+
# When you specify a value for this parameter, AWS IoT Core sends jobs
|
|
455
|
+
# notifications to MQTT topics that contain the value in the following
|
|
456
|
+
# format.
|
|
457
|
+
#
|
|
458
|
+
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
|
459
|
+
#
|
|
460
|
+
# <note markdown="1"> The `namespaceId` feature is in public preview.
|
|
461
|
+
#
|
|
462
|
+
# </note>
|
|
463
|
+
#
|
|
451
464
|
# @return [Types::AssociateTargetsWithJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
452
465
|
#
|
|
453
466
|
# * {Types::AssociateTargetsWithJobResponse#job_arn #job_arn} => String
|
|
@@ -460,6 +473,7 @@ module Aws::IoT
|
|
|
460
473
|
# targets: ["TargetArn"], # required
|
|
461
474
|
# job_id: "JobId", # required
|
|
462
475
|
# comment: "Comment",
|
|
476
|
+
# namespace_id: "NamespaceId",
|
|
463
477
|
# })
|
|
464
478
|
#
|
|
465
479
|
# @example Response structure
|
|
@@ -1347,6 +1361,19 @@ module Aws::IoT
|
|
|
1347
1361
|
# @option params [Array<Types::Tag>] :tags
|
|
1348
1362
|
# Metadata which can be used to manage the job.
|
|
1349
1363
|
#
|
|
1364
|
+
# @option params [String] :namespace_id
|
|
1365
|
+
# The namespace used to indicate that a job is a customer-managed job.
|
|
1366
|
+
#
|
|
1367
|
+
# When you specify a value for this parameter, AWS IoT Core sends jobs
|
|
1368
|
+
# notifications to MQTT topics that contain the value in the following
|
|
1369
|
+
# format.
|
|
1370
|
+
#
|
|
1371
|
+
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
|
1372
|
+
#
|
|
1373
|
+
# <note markdown="1"> The `namespaceId` feature is in public preview.
|
|
1374
|
+
#
|
|
1375
|
+
# </note>
|
|
1376
|
+
#
|
|
1350
1377
|
# @return [Types::CreateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1351
1378
|
#
|
|
1352
1379
|
# * {Types::CreateJobResponse#job_arn #job_arn} => String
|
|
@@ -1396,6 +1423,7 @@ module Aws::IoT
|
|
|
1396
1423
|
# value: "TagValue",
|
|
1397
1424
|
# },
|
|
1398
1425
|
# ],
|
|
1426
|
+
# namespace_id: "NamespaceId",
|
|
1399
1427
|
# })
|
|
1400
1428
|
#
|
|
1401
1429
|
# @example Response structure
|
|
@@ -2101,13 +2129,13 @@ module Aws::IoT
|
|
|
2101
2129
|
# (thing) violates a behavior.
|
|
2102
2130
|
#
|
|
2103
2131
|
# @option params [Array<String>] :additional_metrics_to_retain
|
|
2132
|
+
# *Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2
|
|
2133
|
+
# instead.*
|
|
2134
|
+
#
|
|
2104
2135
|
# A list of metrics whose data is retained (stored). By default, data is
|
|
2105
2136
|
# retained for any metric used in the profile's `behaviors`, but it is
|
|
2106
2137
|
# also retained for any metric specified here.
|
|
2107
2138
|
#
|
|
2108
|
-
# **Note:** This API field is deprecated. Please use
|
|
2109
|
-
# CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
|
|
2110
|
-
#
|
|
2111
2139
|
# @option params [Array<Types::MetricToRetain>] :additional_metrics_to_retain_v2
|
|
2112
2140
|
# A list of metrics whose data is retained (stored). By default, data is
|
|
2113
2141
|
# retained for any metric used in the profile's `behaviors`, but it is
|
|
@@ -2516,6 +2544,7 @@ module Aws::IoT
|
|
|
2516
2544
|
# role_arn: "AwsArn", # required
|
|
2517
2545
|
# delivery_stream_name: "DeliveryStreamName", # required
|
|
2518
2546
|
# separator: "FirehoseSeparator",
|
|
2547
|
+
# batch_mode: false,
|
|
2519
2548
|
# },
|
|
2520
2549
|
# cloudwatch_metric: {
|
|
2521
2550
|
# role_arn: "AwsArn", # required
|
|
@@ -2549,11 +2578,13 @@ module Aws::IoT
|
|
|
2549
2578
|
# iot_analytics: {
|
|
2550
2579
|
# channel_arn: "AwsArn",
|
|
2551
2580
|
# channel_name: "ChannelName",
|
|
2581
|
+
# batch_mode: false,
|
|
2552
2582
|
# role_arn: "AwsArn",
|
|
2553
2583
|
# },
|
|
2554
2584
|
# iot_events: {
|
|
2555
2585
|
# input_name: "InputName", # required
|
|
2556
2586
|
# message_id: "MessageId",
|
|
2587
|
+
# batch_mode: false,
|
|
2557
2588
|
# role_arn: "AwsArn", # required
|
|
2558
2589
|
# },
|
|
2559
2590
|
# iot_site_wise: {
|
|
@@ -2587,6 +2618,21 @@ module Aws::IoT
|
|
|
2587
2618
|
# state_machine_name: "StateMachineName", # required
|
|
2588
2619
|
# role_arn: "AwsArn", # required
|
|
2589
2620
|
# },
|
|
2621
|
+
# timestream: {
|
|
2622
|
+
# role_arn: "AwsArn", # required
|
|
2623
|
+
# database_name: "TimestreamDatabaseName", # required
|
|
2624
|
+
# table_name: "TimestreamTableName", # required
|
|
2625
|
+
# dimensions: [ # required
|
|
2626
|
+
# {
|
|
2627
|
+
# name: "TimestreamDimensionName", # required
|
|
2628
|
+
# value: "TimestreamDimensionValue", # required
|
|
2629
|
+
# },
|
|
2630
|
+
# ],
|
|
2631
|
+
# timestamp: {
|
|
2632
|
+
# value: "TimestreamTimestampValue", # required
|
|
2633
|
+
# unit: "TimestreamTimestampUnit", # required
|
|
2634
|
+
# },
|
|
2635
|
+
# },
|
|
2590
2636
|
# http: {
|
|
2591
2637
|
# url: "Url", # required
|
|
2592
2638
|
# confirmation_url: "Url",
|
|
@@ -2660,6 +2706,7 @@ module Aws::IoT
|
|
|
2660
2706
|
# role_arn: "AwsArn", # required
|
|
2661
2707
|
# delivery_stream_name: "DeliveryStreamName", # required
|
|
2662
2708
|
# separator: "FirehoseSeparator",
|
|
2709
|
+
# batch_mode: false,
|
|
2663
2710
|
# },
|
|
2664
2711
|
# cloudwatch_metric: {
|
|
2665
2712
|
# role_arn: "AwsArn", # required
|
|
@@ -2693,11 +2740,13 @@ module Aws::IoT
|
|
|
2693
2740
|
# iot_analytics: {
|
|
2694
2741
|
# channel_arn: "AwsArn",
|
|
2695
2742
|
# channel_name: "ChannelName",
|
|
2743
|
+
# batch_mode: false,
|
|
2696
2744
|
# role_arn: "AwsArn",
|
|
2697
2745
|
# },
|
|
2698
2746
|
# iot_events: {
|
|
2699
2747
|
# input_name: "InputName", # required
|
|
2700
2748
|
# message_id: "MessageId",
|
|
2749
|
+
# batch_mode: false,
|
|
2701
2750
|
# role_arn: "AwsArn", # required
|
|
2702
2751
|
# },
|
|
2703
2752
|
# iot_site_wise: {
|
|
@@ -2731,6 +2780,21 @@ module Aws::IoT
|
|
|
2731
2780
|
# state_machine_name: "StateMachineName", # required
|
|
2732
2781
|
# role_arn: "AwsArn", # required
|
|
2733
2782
|
# },
|
|
2783
|
+
# timestream: {
|
|
2784
|
+
# role_arn: "AwsArn", # required
|
|
2785
|
+
# database_name: "TimestreamDatabaseName", # required
|
|
2786
|
+
# table_name: "TimestreamTableName", # required
|
|
2787
|
+
# dimensions: [ # required
|
|
2788
|
+
# {
|
|
2789
|
+
# name: "TimestreamDimensionName", # required
|
|
2790
|
+
# value: "TimestreamDimensionValue", # required
|
|
2791
|
+
# },
|
|
2792
|
+
# ],
|
|
2793
|
+
# timestamp: {
|
|
2794
|
+
# value: "TimestreamTimestampValue", # required
|
|
2795
|
+
# unit: "TimestreamTimestampUnit", # required
|
|
2796
|
+
# },
|
|
2797
|
+
# },
|
|
2734
2798
|
# http: {
|
|
2735
2799
|
# url: "Url", # required
|
|
2736
2800
|
# confirmation_url: "Url",
|
|
@@ -3056,6 +3120,19 @@ module Aws::IoT
|
|
|
3056
3120
|
#
|
|
3057
3121
|
# </note>
|
|
3058
3122
|
#
|
|
3123
|
+
# @option params [String] :namespace_id
|
|
3124
|
+
# The namespace used to indicate that a job is a customer-managed job.
|
|
3125
|
+
#
|
|
3126
|
+
# When you specify a value for this parameter, AWS IoT Core sends jobs
|
|
3127
|
+
# notifications to MQTT topics that contain the value in the following
|
|
3128
|
+
# format.
|
|
3129
|
+
#
|
|
3130
|
+
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
|
3131
|
+
#
|
|
3132
|
+
# <note markdown="1"> The `namespaceId` feature is in public preview.
|
|
3133
|
+
#
|
|
3134
|
+
# </note>
|
|
3135
|
+
#
|
|
3059
3136
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3060
3137
|
#
|
|
3061
3138
|
# @example Request syntax with placeholder values
|
|
@@ -3063,6 +3140,7 @@ module Aws::IoT
|
|
|
3063
3140
|
# resp = client.delete_job({
|
|
3064
3141
|
# job_id: "JobId", # required
|
|
3065
3142
|
# force: false,
|
|
3143
|
+
# namespace_id: "NamespaceId",
|
|
3066
3144
|
# })
|
|
3067
3145
|
#
|
|
3068
3146
|
# @overload delete_job(params = {})
|
|
@@ -3102,6 +3180,19 @@ module Aws::IoT
|
|
|
3102
3180
|
#
|
|
3103
3181
|
# </note>
|
|
3104
3182
|
#
|
|
3183
|
+
# @option params [String] :namespace_id
|
|
3184
|
+
# The namespace used to indicate that a job is a customer-managed job.
|
|
3185
|
+
#
|
|
3186
|
+
# When you specify a value for this parameter, AWS IoT Core sends jobs
|
|
3187
|
+
# notifications to MQTT topics that contain the value in the following
|
|
3188
|
+
# format.
|
|
3189
|
+
#
|
|
3190
|
+
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
|
3191
|
+
#
|
|
3192
|
+
# <note markdown="1"> The `namespaceId` feature is in public preview.
|
|
3193
|
+
#
|
|
3194
|
+
# </note>
|
|
3195
|
+
#
|
|
3105
3196
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3106
3197
|
#
|
|
3107
3198
|
# @example Request syntax with placeholder values
|
|
@@ -3111,6 +3202,7 @@ module Aws::IoT
|
|
|
3111
3202
|
# thing_name: "ThingName", # required
|
|
3112
3203
|
# execution_number: 1, # required
|
|
3113
3204
|
# force: false,
|
|
3205
|
+
# namespace_id: "NamespaceId",
|
|
3114
3206
|
# })
|
|
3115
3207
|
#
|
|
3116
3208
|
# @overload delete_job_execution(params = {})
|
|
@@ -4044,6 +4136,7 @@ module Aws::IoT
|
|
|
4044
4136
|
# * {Types::DescribeDomainConfigurationResponse#domain_configuration_status #domain_configuration_status} => String
|
|
4045
4137
|
# * {Types::DescribeDomainConfigurationResponse#service_type #service_type} => String
|
|
4046
4138
|
# * {Types::DescribeDomainConfigurationResponse#domain_type #domain_type} => String
|
|
4139
|
+
# * {Types::DescribeDomainConfigurationResponse#last_status_change_date #last_status_change_date} => Time
|
|
4047
4140
|
#
|
|
4048
4141
|
# @example Request syntax with placeholder values
|
|
4049
4142
|
#
|
|
@@ -4065,6 +4158,7 @@ module Aws::IoT
|
|
|
4065
4158
|
# resp.domain_configuration_status #=> String, one of "ENABLED", "DISABLED"
|
|
4066
4159
|
# resp.service_type #=> String, one of "DATA", "CREDENTIAL_PROVIDER", "JOBS"
|
|
4067
4160
|
# resp.domain_type #=> String, one of "ENDPOINT", "AWS_MANAGED", "CUSTOMER_MANAGED"
|
|
4161
|
+
# resp.last_status_change_date #=> Time
|
|
4068
4162
|
#
|
|
4069
4163
|
# @overload describe_domain_configuration(params = {})
|
|
4070
4164
|
# @param [Hash] params ({})
|
|
@@ -4230,6 +4324,7 @@ module Aws::IoT
|
|
|
4230
4324
|
# resp.job.job_process_details.number_of_removed_things #=> Integer
|
|
4231
4325
|
# resp.job.job_process_details.number_of_timed_out_things #=> Integer
|
|
4232
4326
|
# resp.job.timeout_config.in_progress_timeout_in_minutes #=> Integer
|
|
4327
|
+
# resp.job.namespace_id #=> String
|
|
4233
4328
|
#
|
|
4234
4329
|
# @overload describe_job(params = {})
|
|
4235
4330
|
# @param [Hash] params ({})
|
|
@@ -5407,6 +5502,7 @@ module Aws::IoT
|
|
|
5407
5502
|
# resp.rule.actions[0].firehose.role_arn #=> String
|
|
5408
5503
|
# resp.rule.actions[0].firehose.delivery_stream_name #=> String
|
|
5409
5504
|
# resp.rule.actions[0].firehose.separator #=> String
|
|
5505
|
+
# resp.rule.actions[0].firehose.batch_mode #=> Boolean
|
|
5410
5506
|
# resp.rule.actions[0].cloudwatch_metric.role_arn #=> String
|
|
5411
5507
|
# resp.rule.actions[0].cloudwatch_metric.metric_namespace #=> String
|
|
5412
5508
|
# resp.rule.actions[0].cloudwatch_metric.metric_name #=> String
|
|
@@ -5428,9 +5524,11 @@ module Aws::IoT
|
|
|
5428
5524
|
# resp.rule.actions[0].salesforce.url #=> String
|
|
5429
5525
|
# resp.rule.actions[0].iot_analytics.channel_arn #=> String
|
|
5430
5526
|
# resp.rule.actions[0].iot_analytics.channel_name #=> String
|
|
5527
|
+
# resp.rule.actions[0].iot_analytics.batch_mode #=> Boolean
|
|
5431
5528
|
# resp.rule.actions[0].iot_analytics.role_arn #=> String
|
|
5432
5529
|
# resp.rule.actions[0].iot_events.input_name #=> String
|
|
5433
5530
|
# resp.rule.actions[0].iot_events.message_id #=> String
|
|
5531
|
+
# resp.rule.actions[0].iot_events.batch_mode #=> Boolean
|
|
5434
5532
|
# resp.rule.actions[0].iot_events.role_arn #=> String
|
|
5435
5533
|
# resp.rule.actions[0].iot_site_wise.put_asset_property_value_entries #=> Array
|
|
5436
5534
|
# resp.rule.actions[0].iot_site_wise.put_asset_property_value_entries[0].entry_id #=> String
|
|
@@ -5449,6 +5547,14 @@ module Aws::IoT
|
|
|
5449
5547
|
# resp.rule.actions[0].step_functions.execution_name_prefix #=> String
|
|
5450
5548
|
# resp.rule.actions[0].step_functions.state_machine_name #=> String
|
|
5451
5549
|
# resp.rule.actions[0].step_functions.role_arn #=> String
|
|
5550
|
+
# resp.rule.actions[0].timestream.role_arn #=> String
|
|
5551
|
+
# resp.rule.actions[0].timestream.database_name #=> String
|
|
5552
|
+
# resp.rule.actions[0].timestream.table_name #=> String
|
|
5553
|
+
# resp.rule.actions[0].timestream.dimensions #=> Array
|
|
5554
|
+
# resp.rule.actions[0].timestream.dimensions[0].name #=> String
|
|
5555
|
+
# resp.rule.actions[0].timestream.dimensions[0].value #=> String
|
|
5556
|
+
# resp.rule.actions[0].timestream.timestamp.value #=> String
|
|
5557
|
+
# resp.rule.actions[0].timestream.timestamp.unit #=> String
|
|
5452
5558
|
# resp.rule.actions[0].http.url #=> String
|
|
5453
5559
|
# resp.rule.actions[0].http.confirmation_url #=> String
|
|
5454
5560
|
# resp.rule.actions[0].http.headers #=> Array
|
|
@@ -5491,6 +5597,7 @@ module Aws::IoT
|
|
|
5491
5597
|
# resp.rule.error_action.firehose.role_arn #=> String
|
|
5492
5598
|
# resp.rule.error_action.firehose.delivery_stream_name #=> String
|
|
5493
5599
|
# resp.rule.error_action.firehose.separator #=> String
|
|
5600
|
+
# resp.rule.error_action.firehose.batch_mode #=> Boolean
|
|
5494
5601
|
# resp.rule.error_action.cloudwatch_metric.role_arn #=> String
|
|
5495
5602
|
# resp.rule.error_action.cloudwatch_metric.metric_namespace #=> String
|
|
5496
5603
|
# resp.rule.error_action.cloudwatch_metric.metric_name #=> String
|
|
@@ -5512,9 +5619,11 @@ module Aws::IoT
|
|
|
5512
5619
|
# resp.rule.error_action.salesforce.url #=> String
|
|
5513
5620
|
# resp.rule.error_action.iot_analytics.channel_arn #=> String
|
|
5514
5621
|
# resp.rule.error_action.iot_analytics.channel_name #=> String
|
|
5622
|
+
# resp.rule.error_action.iot_analytics.batch_mode #=> Boolean
|
|
5515
5623
|
# resp.rule.error_action.iot_analytics.role_arn #=> String
|
|
5516
5624
|
# resp.rule.error_action.iot_events.input_name #=> String
|
|
5517
5625
|
# resp.rule.error_action.iot_events.message_id #=> String
|
|
5626
|
+
# resp.rule.error_action.iot_events.batch_mode #=> Boolean
|
|
5518
5627
|
# resp.rule.error_action.iot_events.role_arn #=> String
|
|
5519
5628
|
# resp.rule.error_action.iot_site_wise.put_asset_property_value_entries #=> Array
|
|
5520
5629
|
# resp.rule.error_action.iot_site_wise.put_asset_property_value_entries[0].entry_id #=> String
|
|
@@ -5533,6 +5642,14 @@ module Aws::IoT
|
|
|
5533
5642
|
# resp.rule.error_action.step_functions.execution_name_prefix #=> String
|
|
5534
5643
|
# resp.rule.error_action.step_functions.state_machine_name #=> String
|
|
5535
5644
|
# resp.rule.error_action.step_functions.role_arn #=> String
|
|
5645
|
+
# resp.rule.error_action.timestream.role_arn #=> String
|
|
5646
|
+
# resp.rule.error_action.timestream.database_name #=> String
|
|
5647
|
+
# resp.rule.error_action.timestream.table_name #=> String
|
|
5648
|
+
# resp.rule.error_action.timestream.dimensions #=> Array
|
|
5649
|
+
# resp.rule.error_action.timestream.dimensions[0].name #=> String
|
|
5650
|
+
# resp.rule.error_action.timestream.dimensions[0].value #=> String
|
|
5651
|
+
# resp.rule.error_action.timestream.timestamp.value #=> String
|
|
5652
|
+
# resp.rule.error_action.timestream.timestamp.unit #=> String
|
|
5536
5653
|
# resp.rule.error_action.http.url #=> String
|
|
5537
5654
|
# resp.rule.error_action.http.confirmation_url #=> String
|
|
5538
5655
|
# resp.rule.error_action.http.headers #=> Array
|
|
@@ -5718,7 +5835,7 @@ module Aws::IoT
|
|
|
5718
5835
|
|
|
5719
5836
|
# Lists the findings (results) of a Device Defender audit or of the
|
|
5720
5837
|
# audits performed during a specified time period. (Findings are
|
|
5721
|
-
# retained for
|
|
5838
|
+
# retained for 90 days.)
|
|
5722
5839
|
#
|
|
5723
5840
|
# @option params [String] :task_id
|
|
5724
5841
|
# A filter to limit results to the audit with the specified ID. You must
|
|
@@ -6036,7 +6153,7 @@ module Aws::IoT
|
|
|
6036
6153
|
#
|
|
6037
6154
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
|
6038
6155
|
# The beginning of the time period. Audit information is retained for a
|
|
6039
|
-
# limited time (
|
|
6156
|
+
# limited time (90 days). Requesting a start time prior to what is
|
|
6040
6157
|
# retained results in an "InvalidRequestException".
|
|
6041
6158
|
#
|
|
6042
6159
|
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
|
@@ -6138,7 +6255,9 @@ module Aws::IoT
|
|
|
6138
6255
|
# Lists the billing groups you have created.
|
|
6139
6256
|
#
|
|
6140
6257
|
# @option params [String] :next_token
|
|
6141
|
-
#
|
|
6258
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
6259
|
+
# previous response; otherwise **null** to receive the first set of
|
|
6260
|
+
# results.
|
|
6142
6261
|
#
|
|
6143
6262
|
# @option params [Integer] :max_results
|
|
6144
6263
|
# The maximum number of results to return per request.
|
|
@@ -6491,6 +6610,19 @@ module Aws::IoT
|
|
|
6491
6610
|
# An optional filter that lets you search for jobs that have the
|
|
6492
6611
|
# specified status.
|
|
6493
6612
|
#
|
|
6613
|
+
# @option params [String] :namespace_id
|
|
6614
|
+
# The namespace used to indicate that a job is a customer-managed job.
|
|
6615
|
+
#
|
|
6616
|
+
# When you specify a value for this parameter, AWS IoT Core sends jobs
|
|
6617
|
+
# notifications to MQTT topics that contain the value in the following
|
|
6618
|
+
# format.
|
|
6619
|
+
#
|
|
6620
|
+
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
|
6621
|
+
#
|
|
6622
|
+
# <note markdown="1"> The `namespaceId` feature is in public preview.
|
|
6623
|
+
#
|
|
6624
|
+
# </note>
|
|
6625
|
+
#
|
|
6494
6626
|
# @option params [Integer] :max_results
|
|
6495
6627
|
# The maximum number of results to be returned per request.
|
|
6496
6628
|
#
|
|
@@ -6509,6 +6641,7 @@ module Aws::IoT
|
|
|
6509
6641
|
# resp = client.list_job_executions_for_thing({
|
|
6510
6642
|
# thing_name: "ThingName", # required
|
|
6511
6643
|
# status: "QUEUED", # accepts QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED
|
|
6644
|
+
# namespace_id: "NamespaceId",
|
|
6512
6645
|
# max_results: 1,
|
|
6513
6646
|
# next_token: "NextToken",
|
|
6514
6647
|
# })
|
|
@@ -6559,6 +6692,19 @@ module Aws::IoT
|
|
|
6559
6692
|
# A filter that limits the returned jobs to those for the specified
|
|
6560
6693
|
# group.
|
|
6561
6694
|
#
|
|
6695
|
+
# @option params [String] :namespace_id
|
|
6696
|
+
# The namespace used to indicate that a job is a customer-managed job.
|
|
6697
|
+
#
|
|
6698
|
+
# When you specify a value for this parameter, AWS IoT Core sends jobs
|
|
6699
|
+
# notifications to MQTT topics that contain the value in the following
|
|
6700
|
+
# format.
|
|
6701
|
+
#
|
|
6702
|
+
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
|
6703
|
+
#
|
|
6704
|
+
# <note markdown="1"> The `namespaceId` feature is in public preview.
|
|
6705
|
+
#
|
|
6706
|
+
# </note>
|
|
6707
|
+
#
|
|
6562
6708
|
# @return [Types::ListJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6563
6709
|
#
|
|
6564
6710
|
# * {Types::ListJobsResponse#jobs #jobs} => Array<Types::JobSummary>
|
|
@@ -6575,6 +6721,7 @@ module Aws::IoT
|
|
|
6575
6721
|
# next_token: "NextToken",
|
|
6576
6722
|
# thing_group_name: "ThingGroupName",
|
|
6577
6723
|
# thing_group_id: "ThingGroupId",
|
|
6724
|
+
# namespace_id: "NamespaceId",
|
|
6578
6725
|
# })
|
|
6579
6726
|
#
|
|
6580
6727
|
# @example Response structure
|
|
@@ -6908,7 +7055,9 @@ module Aws::IoT
|
|
|
6908
7055
|
# Cognito identities or federated identities.
|
|
6909
7056
|
#
|
|
6910
7057
|
# @option params [String] :next_token
|
|
6911
|
-
#
|
|
7058
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7059
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7060
|
+
# results.
|
|
6912
7061
|
#
|
|
6913
7062
|
# @option params [Integer] :max_results
|
|
6914
7063
|
# The maximum number of results to return in this operation.
|
|
@@ -7242,7 +7391,9 @@ module Aws::IoT
|
|
|
7242
7391
|
# The ARN of the resource.
|
|
7243
7392
|
#
|
|
7244
7393
|
# @option params [String] :next_token
|
|
7245
|
-
#
|
|
7394
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7395
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7396
|
+
# results.
|
|
7246
7397
|
#
|
|
7247
7398
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7248
7399
|
#
|
|
@@ -7354,7 +7505,9 @@ module Aws::IoT
|
|
|
7354
7505
|
# List the thing groups in your account.
|
|
7355
7506
|
#
|
|
7356
7507
|
# @option params [String] :next_token
|
|
7357
|
-
#
|
|
7508
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7509
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7510
|
+
# results.
|
|
7358
7511
|
#
|
|
7359
7512
|
# @option params [Integer] :max_results
|
|
7360
7513
|
# The maximum number of results to return at one time.
|
|
@@ -7407,7 +7560,9 @@ module Aws::IoT
|
|
|
7407
7560
|
# The thing name.
|
|
7408
7561
|
#
|
|
7409
7562
|
# @option params [String] :next_token
|
|
7410
|
-
#
|
|
7563
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7564
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7565
|
+
# results.
|
|
7411
7566
|
#
|
|
7412
7567
|
# @option params [Integer] :max_results
|
|
7413
7568
|
# The maximum number of results to return at one time.
|
|
@@ -7445,16 +7600,29 @@ module Aws::IoT
|
|
|
7445
7600
|
# can be X.509 certificates, IAM users, groups, and roles, Amazon
|
|
7446
7601
|
# Cognito identities or federated identities.
|
|
7447
7602
|
#
|
|
7603
|
+
# @option params [String] :next_token
|
|
7604
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7605
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7606
|
+
# results.
|
|
7607
|
+
#
|
|
7608
|
+
# @option params [Integer] :max_results
|
|
7609
|
+
# The maximum number of results to return in this operation.
|
|
7610
|
+
#
|
|
7448
7611
|
# @option params [required, String] :thing_name
|
|
7449
7612
|
# The name of the thing.
|
|
7450
7613
|
#
|
|
7451
7614
|
# @return [Types::ListThingPrincipalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7452
7615
|
#
|
|
7453
7616
|
# * {Types::ListThingPrincipalsResponse#principals #principals} => Array<String>
|
|
7617
|
+
# * {Types::ListThingPrincipalsResponse#next_token #next_token} => String
|
|
7618
|
+
#
|
|
7619
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
7454
7620
|
#
|
|
7455
7621
|
# @example Request syntax with placeholder values
|
|
7456
7622
|
#
|
|
7457
7623
|
# resp = client.list_thing_principals({
|
|
7624
|
+
# next_token: "NextToken",
|
|
7625
|
+
# max_results: 1,
|
|
7458
7626
|
# thing_name: "ThingName", # required
|
|
7459
7627
|
# })
|
|
7460
7628
|
#
|
|
@@ -7462,6 +7630,7 @@ module Aws::IoT
|
|
|
7462
7630
|
#
|
|
7463
7631
|
# resp.principals #=> Array
|
|
7464
7632
|
# resp.principals[0] #=> String
|
|
7633
|
+
# resp.next_token #=> String
|
|
7465
7634
|
#
|
|
7466
7635
|
# @overload list_thing_principals(params = {})
|
|
7467
7636
|
# @param [Hash] params ({})
|
|
@@ -7479,7 +7648,9 @@ module Aws::IoT
|
|
|
7479
7648
|
# The type of task report.
|
|
7480
7649
|
#
|
|
7481
7650
|
# @option params [String] :next_token
|
|
7482
|
-
#
|
|
7651
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7652
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7653
|
+
# results.
|
|
7483
7654
|
#
|
|
7484
7655
|
# @option params [Integer] :max_results
|
|
7485
7656
|
# The maximum number of results to return per request.
|
|
@@ -7518,7 +7689,9 @@ module Aws::IoT
|
|
|
7518
7689
|
# List bulk thing provisioning tasks.
|
|
7519
7690
|
#
|
|
7520
7691
|
# @option params [String] :next_token
|
|
7521
|
-
#
|
|
7692
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7693
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7694
|
+
# results.
|
|
7522
7695
|
#
|
|
7523
7696
|
# @option params [Integer] :max_results
|
|
7524
7697
|
# The maximum number of results to return at one time.
|
|
@@ -7557,7 +7730,9 @@ module Aws::IoT
|
|
|
7557
7730
|
# Lists the existing thing types.
|
|
7558
7731
|
#
|
|
7559
7732
|
# @option params [String] :next_token
|
|
7560
|
-
#
|
|
7733
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7734
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7735
|
+
# results.
|
|
7561
7736
|
#
|
|
7562
7737
|
# @option params [Integer] :max_results
|
|
7563
7738
|
# The maximum number of results to return in this operation.
|
|
@@ -7614,7 +7789,9 @@ module Aws::IoT
|
|
|
7614
7789
|
# </note>
|
|
7615
7790
|
#
|
|
7616
7791
|
# @option params [String] :next_token
|
|
7617
|
-
#
|
|
7792
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7793
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7794
|
+
# results.
|
|
7618
7795
|
#
|
|
7619
7796
|
# @option params [Integer] :max_results
|
|
7620
7797
|
# The maximum number of results to return in this operation.
|
|
@@ -7669,7 +7846,9 @@ module Aws::IoT
|
|
|
7669
7846
|
# The name of the billing group.
|
|
7670
7847
|
#
|
|
7671
7848
|
# @option params [String] :next_token
|
|
7672
|
-
#
|
|
7849
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7850
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7851
|
+
# results.
|
|
7673
7852
|
#
|
|
7674
7853
|
# @option params [Integer] :max_results
|
|
7675
7854
|
# The maximum number of results to return per request.
|
|
@@ -7712,7 +7891,9 @@ module Aws::IoT
|
|
|
7712
7891
|
# well.
|
|
7713
7892
|
#
|
|
7714
7893
|
# @option params [String] :next_token
|
|
7715
|
-
#
|
|
7894
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7895
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7896
|
+
# results.
|
|
7716
7897
|
#
|
|
7717
7898
|
# @option params [Integer] :max_results
|
|
7718
7899
|
# The maximum number of results to return at one time.
|
|
@@ -7752,7 +7933,9 @@ module Aws::IoT
|
|
|
7752
7933
|
# The maximum number of results to return at one time.
|
|
7753
7934
|
#
|
|
7754
7935
|
# @option params [String] :next_token
|
|
7755
|
-
#
|
|
7936
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7937
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7938
|
+
# results.
|
|
7756
7939
|
#
|
|
7757
7940
|
# @return [Types::ListTopicRuleDestinationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7758
7941
|
#
|
|
@@ -7793,7 +7976,9 @@ module Aws::IoT
|
|
|
7793
7976
|
# The maximum number of results to return.
|
|
7794
7977
|
#
|
|
7795
7978
|
# @option params [String] :next_token
|
|
7796
|
-
#
|
|
7979
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
7980
|
+
# previous response; otherwise **null** to receive the first set of
|
|
7981
|
+
# results.
|
|
7797
7982
|
#
|
|
7798
7983
|
# @option params [Boolean] :rule_disabled
|
|
7799
7984
|
# Specifies whether the rule is disabled.
|
|
@@ -7838,8 +8023,9 @@ module Aws::IoT
|
|
|
7838
8023
|
# `THING_Group`.
|
|
7839
8024
|
#
|
|
7840
8025
|
# @option params [String] :next_token
|
|
7841
|
-
#
|
|
7842
|
-
#
|
|
8026
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
8027
|
+
# previous response; otherwise **null** to receive the first set of
|
|
8028
|
+
# results.
|
|
7843
8029
|
#
|
|
7844
8030
|
# @option params [Integer] :max_results
|
|
7845
8031
|
# The maximum number of results to return at one time.
|
|
@@ -8334,6 +8520,7 @@ module Aws::IoT
|
|
|
8334
8520
|
# role_arn: "AwsArn", # required
|
|
8335
8521
|
# delivery_stream_name: "DeliveryStreamName", # required
|
|
8336
8522
|
# separator: "FirehoseSeparator",
|
|
8523
|
+
# batch_mode: false,
|
|
8337
8524
|
# },
|
|
8338
8525
|
# cloudwatch_metric: {
|
|
8339
8526
|
# role_arn: "AwsArn", # required
|
|
@@ -8367,11 +8554,13 @@ module Aws::IoT
|
|
|
8367
8554
|
# iot_analytics: {
|
|
8368
8555
|
# channel_arn: "AwsArn",
|
|
8369
8556
|
# channel_name: "ChannelName",
|
|
8557
|
+
# batch_mode: false,
|
|
8370
8558
|
# role_arn: "AwsArn",
|
|
8371
8559
|
# },
|
|
8372
8560
|
# iot_events: {
|
|
8373
8561
|
# input_name: "InputName", # required
|
|
8374
8562
|
# message_id: "MessageId",
|
|
8563
|
+
# batch_mode: false,
|
|
8375
8564
|
# role_arn: "AwsArn", # required
|
|
8376
8565
|
# },
|
|
8377
8566
|
# iot_site_wise: {
|
|
@@ -8405,6 +8594,21 @@ module Aws::IoT
|
|
|
8405
8594
|
# state_machine_name: "StateMachineName", # required
|
|
8406
8595
|
# role_arn: "AwsArn", # required
|
|
8407
8596
|
# },
|
|
8597
|
+
# timestream: {
|
|
8598
|
+
# role_arn: "AwsArn", # required
|
|
8599
|
+
# database_name: "TimestreamDatabaseName", # required
|
|
8600
|
+
# table_name: "TimestreamTableName", # required
|
|
8601
|
+
# dimensions: [ # required
|
|
8602
|
+
# {
|
|
8603
|
+
# name: "TimestreamDimensionName", # required
|
|
8604
|
+
# value: "TimestreamDimensionValue", # required
|
|
8605
|
+
# },
|
|
8606
|
+
# ],
|
|
8607
|
+
# timestamp: {
|
|
8608
|
+
# value: "TimestreamTimestampValue", # required
|
|
8609
|
+
# unit: "TimestreamTimestampUnit", # required
|
|
8610
|
+
# },
|
|
8611
|
+
# },
|
|
8408
8612
|
# http: {
|
|
8409
8613
|
# url: "Url", # required
|
|
8410
8614
|
# confirmation_url: "Url",
|
|
@@ -8478,6 +8682,7 @@ module Aws::IoT
|
|
|
8478
8682
|
# role_arn: "AwsArn", # required
|
|
8479
8683
|
# delivery_stream_name: "DeliveryStreamName", # required
|
|
8480
8684
|
# separator: "FirehoseSeparator",
|
|
8685
|
+
# batch_mode: false,
|
|
8481
8686
|
# },
|
|
8482
8687
|
# cloudwatch_metric: {
|
|
8483
8688
|
# role_arn: "AwsArn", # required
|
|
@@ -8511,11 +8716,13 @@ module Aws::IoT
|
|
|
8511
8716
|
# iot_analytics: {
|
|
8512
8717
|
# channel_arn: "AwsArn",
|
|
8513
8718
|
# channel_name: "ChannelName",
|
|
8719
|
+
# batch_mode: false,
|
|
8514
8720
|
# role_arn: "AwsArn",
|
|
8515
8721
|
# },
|
|
8516
8722
|
# iot_events: {
|
|
8517
8723
|
# input_name: "InputName", # required
|
|
8518
8724
|
# message_id: "MessageId",
|
|
8725
|
+
# batch_mode: false,
|
|
8519
8726
|
# role_arn: "AwsArn", # required
|
|
8520
8727
|
# },
|
|
8521
8728
|
# iot_site_wise: {
|
|
@@ -8549,6 +8756,21 @@ module Aws::IoT
|
|
|
8549
8756
|
# state_machine_name: "StateMachineName", # required
|
|
8550
8757
|
# role_arn: "AwsArn", # required
|
|
8551
8758
|
# },
|
|
8759
|
+
# timestream: {
|
|
8760
|
+
# role_arn: "AwsArn", # required
|
|
8761
|
+
# database_name: "TimestreamDatabaseName", # required
|
|
8762
|
+
# table_name: "TimestreamTableName", # required
|
|
8763
|
+
# dimensions: [ # required
|
|
8764
|
+
# {
|
|
8765
|
+
# name: "TimestreamDimensionName", # required
|
|
8766
|
+
# value: "TimestreamDimensionValue", # required
|
|
8767
|
+
# },
|
|
8768
|
+
# ],
|
|
8769
|
+
# timestamp: {
|
|
8770
|
+
# value: "TimestreamTimestampValue", # required
|
|
8771
|
+
# unit: "TimestreamTimestampUnit", # required
|
|
8772
|
+
# },
|
|
8773
|
+
# },
|
|
8552
8774
|
# http: {
|
|
8553
8775
|
# url: "Url", # required
|
|
8554
8776
|
# confirmation_url: "Url",
|
|
@@ -9705,6 +9927,19 @@ module Aws::IoT
|
|
|
9705
9927
|
# terminal state before the time expires, it will be automatically set
|
|
9706
9928
|
# to `TIMED_OUT`.
|
|
9707
9929
|
#
|
|
9930
|
+
# @option params [String] :namespace_id
|
|
9931
|
+
# The namespace used to indicate that a job is a customer-managed job.
|
|
9932
|
+
#
|
|
9933
|
+
# When you specify a value for this parameter, AWS IoT Core sends jobs
|
|
9934
|
+
# notifications to MQTT topics that contain the value in the following
|
|
9935
|
+
# format.
|
|
9936
|
+
#
|
|
9937
|
+
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
|
9938
|
+
#
|
|
9939
|
+
# <note markdown="1"> The `namespaceId` feature is in public preview.
|
|
9940
|
+
#
|
|
9941
|
+
# </note>
|
|
9942
|
+
#
|
|
9708
9943
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
9709
9944
|
#
|
|
9710
9945
|
# @example Request syntax with placeholder values
|
|
@@ -9740,6 +9975,7 @@ module Aws::IoT
|
|
|
9740
9975
|
# timeout_config: {
|
|
9741
9976
|
# in_progress_timeout_in_minutes: 1,
|
|
9742
9977
|
# },
|
|
9978
|
+
# namespace_id: "NamespaceId",
|
|
9743
9979
|
# })
|
|
9744
9980
|
#
|
|
9745
9981
|
# @overload update_job(params = {})
|
|
@@ -9963,13 +10199,13 @@ module Aws::IoT
|
|
|
9963
10199
|
# Where the alerts are sent. (Alerts are always sent to the console.)
|
|
9964
10200
|
#
|
|
9965
10201
|
# @option params [Array<String>] :additional_metrics_to_retain
|
|
10202
|
+
# *Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2
|
|
10203
|
+
# instead.*
|
|
10204
|
+
#
|
|
9966
10205
|
# A list of metrics whose data is retained (stored). By default, data is
|
|
9967
10206
|
# retained for any metric used in the profile's `behaviors`, but it is
|
|
9968
10207
|
# also retained for any metric specified here.
|
|
9969
10208
|
#
|
|
9970
|
-
# **Note:** This API field is deprecated. Please use
|
|
9971
|
-
# UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
|
|
9972
|
-
#
|
|
9973
10209
|
# @option params [Array<Types::MetricToRetain>] :additional_metrics_to_retain_v2
|
|
9974
10210
|
# A list of metrics whose data is retained (stored). By default, data is
|
|
9975
10211
|
# retained for any metric used in the profile's behaviors, but it is
|
|
@@ -10407,7 +10643,7 @@ module Aws::IoT
|
|
|
10407
10643
|
params: params,
|
|
10408
10644
|
config: config)
|
|
10409
10645
|
context[:gem_name] = 'aws-sdk-iot'
|
|
10410
|
-
context[:gem_version] = '1.
|
|
10646
|
+
context[:gem_version] = '1.62.0'
|
|
10411
10647
|
Seahorse::Client::Request.new(handlers, context)
|
|
10412
10648
|
end
|
|
10413
10649
|
|