aws-sdk-iot 1.87.0 → 1.90.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iot/client.rb +97 -3
- data/lib/aws-sdk-iot/client_api.rb +47 -1
- data/lib/aws-sdk-iot/types.rb +159 -4
- 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: 645736ed511b1c815eb13a155f292d5eca9cd70d85e20dbf4cb2e93d23255a65
|
4
|
+
data.tar.gz: 28717088bfd05b44a44d955a41cab7d00e725a1be5150e4043059081120938c0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 27414e8c1c9031c46a5618cc91a8cba95cd18a84121b1d6607980096c75a27919c929057d0988836ee7254ff9067dcaf5830e3f9bc01eed5a29f8a163f5e26fb
|
7
|
+
data.tar.gz: 51091e4736399eac0687ea7ff790dca2176a1a9ba78ddb0cf456e0ce29e99fcd3c3f8340e81dbf526101380689f4e4faea5b8e2f4445ba7500da88f5801a193e
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.90.0 (2022-05-12)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Documentation update for China region ListMetricValues for IoT
|
8
|
+
|
9
|
+
1.89.0 (2022-05-05)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - AWS IoT Jobs now allows you to create up to 100,000 active continuous and snapshot jobs by using concurrency control.
|
13
|
+
|
14
|
+
1.88.0 (2022-04-04)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - AWS IoT - AWS IoT Device Defender adds support to list metric datapoints collected for IoT devices through the ListMetricValues API
|
18
|
+
|
4
19
|
1.87.0 (2022-03-30)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.90.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
|
#
|
@@ -5526,6 +5539,7 @@ module Aws::IoT
|
|
5526
5539
|
# resp.job.job_executions_retry_config.criteria_list[0].number_of_retries #=> Integer
|
5527
5540
|
# resp.job.document_parameters #=> Hash
|
5528
5541
|
# resp.job.document_parameters["ParameterKey"] #=> String
|
5542
|
+
# resp.job.is_concurrent #=> Boolean
|
5529
5543
|
#
|
5530
5544
|
# @overload describe_job(params = {})
|
5531
5545
|
# @param [Hash] params ({})
|
@@ -8769,6 +8783,13 @@ module Aws::IoT
|
|
8769
8783
|
# a thing when the thing is added to a target group, even after the job
|
8770
8784
|
# was completed by all things originally in the group.
|
8771
8785
|
#
|
8786
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs for
|
8787
|
+
# dynamic thing group targets. By using continuous jobs, devices that
|
8788
|
+
# join the group receive the job execution even after the job has been
|
8789
|
+
# created.
|
8790
|
+
#
|
8791
|
+
# </note>
|
8792
|
+
#
|
8772
8793
|
# @option params [Integer] :max_results
|
8773
8794
|
# The maximum number of results to return per request.
|
8774
8795
|
#
|
@@ -8826,6 +8847,7 @@ module Aws::IoT
|
|
8826
8847
|
# resp.jobs[0].created_at #=> Time
|
8827
8848
|
# resp.jobs[0].last_updated_at #=> Time
|
8828
8849
|
# resp.jobs[0].completed_at #=> Time
|
8850
|
+
# resp.jobs[0].is_concurrent #=> Boolean
|
8829
8851
|
# resp.next_token #=> String
|
8830
8852
|
#
|
8831
8853
|
# @overload list_jobs(params = {})
|
@@ -8879,6 +8901,78 @@ module Aws::IoT
|
|
8879
8901
|
req.send_request(options)
|
8880
8902
|
end
|
8881
8903
|
|
8904
|
+
# Lists the values reported for an IoT Device Defender metric
|
8905
|
+
# (device-side metric, cloud-side metric, or custom metric) by the given
|
8906
|
+
# thing during the specified time period.
|
8907
|
+
#
|
8908
|
+
# @option params [required, String] :thing_name
|
8909
|
+
# The name of the thing for which security profile metric values are
|
8910
|
+
# returned.
|
8911
|
+
#
|
8912
|
+
# @option params [required, String] :metric_name
|
8913
|
+
# The name of the security profile metric for which values are returned.
|
8914
|
+
#
|
8915
|
+
# @option params [String] :dimension_name
|
8916
|
+
# The dimension name.
|
8917
|
+
#
|
8918
|
+
# @option params [String] :dimension_value_operator
|
8919
|
+
# The dimension value operator.
|
8920
|
+
#
|
8921
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
8922
|
+
# The start of the time period for which metric values are returned.
|
8923
|
+
#
|
8924
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
8925
|
+
# The end of the time period for which metric values are returned.
|
8926
|
+
#
|
8927
|
+
# @option params [Integer] :max_results
|
8928
|
+
# The maximum number of results to return at one time.
|
8929
|
+
#
|
8930
|
+
# @option params [String] :next_token
|
8931
|
+
# The token for the next set of results.
|
8932
|
+
#
|
8933
|
+
# @return [Types::ListMetricValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8934
|
+
#
|
8935
|
+
# * {Types::ListMetricValuesResponse#metric_datum_list #metric_datum_list} => Array<Types::MetricDatum>
|
8936
|
+
# * {Types::ListMetricValuesResponse#next_token #next_token} => String
|
8937
|
+
#
|
8938
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8939
|
+
#
|
8940
|
+
# @example Request syntax with placeholder values
|
8941
|
+
#
|
8942
|
+
# resp = client.list_metric_values({
|
8943
|
+
# thing_name: "DeviceDefenderThingName", # required
|
8944
|
+
# metric_name: "BehaviorMetric", # required
|
8945
|
+
# dimension_name: "DimensionName",
|
8946
|
+
# dimension_value_operator: "IN", # accepts IN, NOT_IN
|
8947
|
+
# start_time: Time.now, # required
|
8948
|
+
# end_time: Time.now, # required
|
8949
|
+
# max_results: 1,
|
8950
|
+
# next_token: "NextToken",
|
8951
|
+
# })
|
8952
|
+
#
|
8953
|
+
# @example Response structure
|
8954
|
+
#
|
8955
|
+
# resp.metric_datum_list #=> Array
|
8956
|
+
# resp.metric_datum_list[0].timestamp #=> Time
|
8957
|
+
# resp.metric_datum_list[0].value.count #=> Integer
|
8958
|
+
# resp.metric_datum_list[0].value.cidrs #=> Array
|
8959
|
+
# resp.metric_datum_list[0].value.cidrs[0] #=> String
|
8960
|
+
# resp.metric_datum_list[0].value.ports #=> Array
|
8961
|
+
# resp.metric_datum_list[0].value.ports[0] #=> Integer
|
8962
|
+
# resp.metric_datum_list[0].value.number #=> Float
|
8963
|
+
# resp.metric_datum_list[0].value.numbers #=> Array
|
8964
|
+
# resp.metric_datum_list[0].value.numbers[0] #=> Float
|
8965
|
+
# resp.metric_datum_list[0].value.strings #=> Array
|
8966
|
+
# resp.metric_datum_list[0].value.strings[0] #=> String
|
8967
|
+
# resp.next_token #=> String
|
8968
|
+
#
|
8969
|
+
# @overload list_metric_values(params = {})
|
8970
|
+
# @param [Hash] params ({})
|
8971
|
+
def list_metric_values(params = {}, options = {})
|
8972
|
+
req = build_request(:list_metric_values, params)
|
8973
|
+
req.send_request(options)
|
8974
|
+
end
|
8975
|
+
|
8882
8976
|
# Gets a list of all mitigation actions that match the specified filter
|
8883
8977
|
# criteria.
|
8884
8978
|
#
|
@@ -13600,7 +13694,7 @@ module Aws::IoT
|
|
13600
13694
|
params: params,
|
13601
13695
|
config: config)
|
13602
13696
|
context[:gem_name] = 'aws-sdk-iot'
|
13603
|
-
context[:gem_version] = '1.
|
13697
|
+
context[:gem_version] = '1.90.0'
|
13604
13698
|
Seahorse::Client::Request.new(handlers, context)
|
13605
13699
|
end
|
13606
13700
|
|
@@ -162,6 +162,7 @@ module Aws::IoT
|
|
162
162
|
BillingGroupProperties = Shapes::StructureShape.new(name: 'BillingGroupProperties')
|
163
163
|
Boolean = Shapes::BooleanShape.new(name: 'Boolean')
|
164
164
|
BooleanKey = Shapes::BooleanShape.new(name: 'BooleanKey')
|
165
|
+
BooleanWrapperObject = Shapes::BooleanShape.new(name: 'BooleanWrapperObject')
|
165
166
|
Bucket = Shapes::StructureShape.new(name: 'Bucket')
|
166
167
|
BucketKeyValue = Shapes::StringShape.new(name: 'BucketKeyValue')
|
167
168
|
BucketName = Shapes::StringShape.new(name: 'BucketName')
|
@@ -700,6 +701,8 @@ module Aws::IoT
|
|
700
701
|
ListJobsResponse = Shapes::StructureShape.new(name: 'ListJobsResponse')
|
701
702
|
ListManagedJobTemplatesRequest = Shapes::StructureShape.new(name: 'ListManagedJobTemplatesRequest')
|
702
703
|
ListManagedJobTemplatesResponse = Shapes::StructureShape.new(name: 'ListManagedJobTemplatesResponse')
|
704
|
+
ListMetricValuesRequest = Shapes::StructureShape.new(name: 'ListMetricValuesRequest')
|
705
|
+
ListMetricValuesResponse = Shapes::StructureShape.new(name: 'ListMetricValuesResponse')
|
703
706
|
ListMitigationActionsRequest = Shapes::StructureShape.new(name: 'ListMitigationActionsRequest')
|
704
707
|
ListMitigationActionsResponse = Shapes::StructureShape.new(name: 'ListMitigationActionsResponse')
|
705
708
|
ListOTAUpdatesRequest = Shapes::StructureShape.new(name: 'ListOTAUpdatesRequest')
|
@@ -787,6 +790,8 @@ module Aws::IoT
|
|
787
790
|
Message = Shapes::StringShape.new(name: 'Message')
|
788
791
|
MessageFormat = Shapes::StringShape.new(name: 'MessageFormat')
|
789
792
|
MessageId = Shapes::StringShape.new(name: 'MessageId')
|
793
|
+
MetricDatum = Shapes::StructureShape.new(name: 'MetricDatum')
|
794
|
+
MetricDatumList = Shapes::ListShape.new(name: 'MetricDatumList')
|
790
795
|
MetricDimension = Shapes::StructureShape.new(name: 'MetricDimension')
|
791
796
|
MetricName = Shapes::StringShape.new(name: 'MetricName')
|
792
797
|
MetricNames = Shapes::ListShape.new(name: 'MetricNames')
|
@@ -1332,7 +1337,7 @@ module Aws::IoT
|
|
1332
1337
|
AddThingToThingGroupResponse.struct_class = Types::AddThingToThingGroupResponse
|
1333
1338
|
|
1334
1339
|
AddThingsToThingGroupParams.add_member(:thing_group_names, Shapes::ShapeRef.new(shape: ThingGroupNames, required: true, location_name: "thingGroupNames"))
|
1335
|
-
AddThingsToThingGroupParams.add_member(:override_dynamic_groups, Shapes::ShapeRef.new(shape:
|
1340
|
+
AddThingsToThingGroupParams.add_member(:override_dynamic_groups, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "overrideDynamicGroups"))
|
1336
1341
|
AddThingsToThingGroupParams.struct_class = Types::AddThingsToThingGroupParams
|
1337
1342
|
|
1338
1343
|
AdditionalMetricsToRetainList.member = Shapes::ShapeRef.new(shape: BehaviorMetric)
|
@@ -3018,6 +3023,7 @@ module Aws::IoT
|
|
3018
3023
|
Job.add_member(:job_template_arn, Shapes::ShapeRef.new(shape: JobTemplateArn, location_name: "jobTemplateArn"))
|
3019
3024
|
Job.add_member(:job_executions_retry_config, Shapes::ShapeRef.new(shape: JobExecutionsRetryConfig, location_name: "jobExecutionsRetryConfig"))
|
3020
3025
|
Job.add_member(:document_parameters, Shapes::ShapeRef.new(shape: ParameterMap, location_name: "documentParameters"))
|
3026
|
+
Job.add_member(:is_concurrent, Shapes::ShapeRef.new(shape: BooleanWrapperObject, location_name: "isConcurrent"))
|
3021
3027
|
Job.struct_class = Types::Job
|
3022
3028
|
|
3023
3029
|
JobExecution.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "jobId"))
|
@@ -3082,6 +3088,7 @@ module Aws::IoT
|
|
3082
3088
|
JobSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: DateType, location_name: "createdAt"))
|
3083
3089
|
JobSummary.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: DateType, location_name: "lastUpdatedAt"))
|
3084
3090
|
JobSummary.add_member(:completed_at, Shapes::ShapeRef.new(shape: DateType, location_name: "completedAt"))
|
3091
|
+
JobSummary.add_member(:is_concurrent, Shapes::ShapeRef.new(shape: BooleanWrapperObject, location_name: "isConcurrent"))
|
3085
3092
|
JobSummary.struct_class = Types::JobSummary
|
3086
3093
|
|
3087
3094
|
JobSummaryList.member = Shapes::ShapeRef.new(shape: JobSummary)
|
@@ -3365,6 +3372,20 @@ module Aws::IoT
|
|
3365
3372
|
ListManagedJobTemplatesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
3366
3373
|
ListManagedJobTemplatesResponse.struct_class = Types::ListManagedJobTemplatesResponse
|
3367
3374
|
|
3375
|
+
ListMetricValuesRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: DeviceDefenderThingName, required: true, location: "querystring", location_name: "thingName"))
|
3376
|
+
ListMetricValuesRequest.add_member(:metric_name, Shapes::ShapeRef.new(shape: BehaviorMetric, required: true, location: "querystring", location_name: "metricName"))
|
3377
|
+
ListMetricValuesRequest.add_member(:dimension_name, Shapes::ShapeRef.new(shape: DimensionName, location: "querystring", location_name: "dimensionName"))
|
3378
|
+
ListMetricValuesRequest.add_member(:dimension_value_operator, Shapes::ShapeRef.new(shape: DimensionValueOperator, location: "querystring", location_name: "dimensionValueOperator"))
|
3379
|
+
ListMetricValuesRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location: "querystring", location_name: "startTime"))
|
3380
|
+
ListMetricValuesRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location: "querystring", location_name: "endTime"))
|
3381
|
+
ListMetricValuesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
3382
|
+
ListMetricValuesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
3383
|
+
ListMetricValuesRequest.struct_class = Types::ListMetricValuesRequest
|
3384
|
+
|
3385
|
+
ListMetricValuesResponse.add_member(:metric_datum_list, Shapes::ShapeRef.new(shape: MetricDatumList, location_name: "metricDatumList"))
|
3386
|
+
ListMetricValuesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
3387
|
+
ListMetricValuesResponse.struct_class = Types::ListMetricValuesResponse
|
3388
|
+
|
3368
3389
|
ListMitigationActionsRequest.add_member(:action_type, Shapes::ShapeRef.new(shape: MitigationActionType, location: "querystring", location_name: "actionType"))
|
3369
3390
|
ListMitigationActionsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
3370
3391
|
ListMitigationActionsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
@@ -3685,6 +3706,12 @@ module Aws::IoT
|
|
3685
3706
|
|
3686
3707
|
ManagedJobTemplatesSummaryList.member = Shapes::ShapeRef.new(shape: ManagedJobTemplateSummary)
|
3687
3708
|
|
3709
|
+
MetricDatum.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "timestamp"))
|
3710
|
+
MetricDatum.add_member(:value, Shapes::ShapeRef.new(shape: MetricValue, location_name: "value"))
|
3711
|
+
MetricDatum.struct_class = Types::MetricDatum
|
3712
|
+
|
3713
|
+
MetricDatumList.member = Shapes::ShapeRef.new(shape: MetricDatum)
|
3714
|
+
|
3688
3715
|
MetricDimension.add_member(:dimension_name, Shapes::ShapeRef.new(shape: DimensionName, required: true, location_name: "dimensionName"))
|
3689
3716
|
MetricDimension.add_member(:operator, Shapes::ShapeRef.new(shape: DimensionValueOperator, location_name: "operator"))
|
3690
3717
|
MetricDimension.struct_class = Types::MetricDimension
|
@@ -4993,6 +5020,7 @@ module Aws::IoT
|
|
4993
5020
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
4994
5021
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
4995
5022
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
5023
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
4996
5024
|
end)
|
4997
5025
|
|
4998
5026
|
api.add_operation(:cancel_job_execution, Seahorse::Model::Operation.new.tap do |o|
|
@@ -7011,6 +7039,24 @@ module Aws::IoT
|
|
7011
7039
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
7012
7040
|
end)
|
7013
7041
|
|
7042
|
+
api.add_operation(:list_metric_values, Seahorse::Model::Operation.new.tap do |o|
|
7043
|
+
o.name = "ListMetricValues"
|
7044
|
+
o.http_method = "GET"
|
7045
|
+
o.http_request_uri = "/metric-values"
|
7046
|
+
o.input = Shapes::ShapeRef.new(shape: ListMetricValuesRequest)
|
7047
|
+
o.output = Shapes::ShapeRef.new(shape: ListMetricValuesResponse)
|
7048
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
7049
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
7050
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
7051
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
7052
|
+
o[:pager] = Aws::Pager.new(
|
7053
|
+
limit_key: "max_results",
|
7054
|
+
tokens: {
|
7055
|
+
"next_token" => "next_token"
|
7056
|
+
}
|
7057
|
+
)
|
7058
|
+
end)
|
7059
|
+
|
7014
7060
|
api.add_operation(:list_mitigation_actions, Seahorse::Model::Operation.new.tap do |o|
|
7015
7061
|
o.name = "ListMitigationActions"
|
7016
7062
|
o.http_method = "GET"
|
data/lib/aws-sdk-iot/types.rb
CHANGED
@@ -3588,6 +3588,13 @@ module Aws::IoT
|
|
3588
3588
|
# on a thing when a change is detected in a target. For example, a job
|
3589
3589
|
# will run on a thing when the thing is added to a target group, even
|
3590
3590
|
# after the job was completed by all things originally in the group.
|
3591
|
+
#
|
3592
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs
|
3593
|
+
# for dynamic thing group targets. By using continuous jobs, devices
|
3594
|
+
# that join the group receive the job execution even after the job has
|
3595
|
+
# been created.
|
3596
|
+
#
|
3597
|
+
# </note>
|
3591
3598
|
# @return [String]
|
3592
3599
|
#
|
3593
3600
|
# @!attribute [rw] job_executions_rollout_config
|
@@ -3633,8 +3640,14 @@ module Aws::IoT
|
|
3633
3640
|
# @return [Types::JobExecutionsRetryConfig]
|
3634
3641
|
#
|
3635
3642
|
# @!attribute [rw] document_parameters
|
3636
|
-
# Parameters of
|
3637
|
-
# job document.
|
3643
|
+
# Parameters of an Amazon Web Services managed template that you can
|
3644
|
+
# specify to create the job document.
|
3645
|
+
#
|
3646
|
+
# <note markdown="1"> `documentParameters` can only be used when creating jobs from Amazon
|
3647
|
+
# Web Services managed templates. This parameter can't be used with
|
3648
|
+
# custom job templates or to create jobs from them.
|
3649
|
+
#
|
3650
|
+
# </note>
|
3638
3651
|
# @return [Hash<String,String>]
|
3639
3652
|
#
|
3640
3653
|
class CreateJobRequest < Struct.new(
|
@@ -7439,6 +7452,12 @@ module Aws::IoT
|
|
7439
7452
|
# @!attribute [rw] document_parameters
|
7440
7453
|
# A map of key-value pairs that you can use as guidance to specify the
|
7441
7454
|
# inputs for creating a job from a managed template.
|
7455
|
+
#
|
7456
|
+
# <note markdown="1"> `documentParameters` can only be used when creating jobs from Amazon
|
7457
|
+
# Web Services managed templates. This parameter can't be used with
|
7458
|
+
# custom job templates or to create jobs from them.
|
7459
|
+
#
|
7460
|
+
# </note>
|
7442
7461
|
# @return [Array<Types::DocumentParameter>]
|
7443
7462
|
#
|
7444
7463
|
# @!attribute [rw] document
|
@@ -8456,6 +8475,12 @@ module Aws::IoT
|
|
8456
8475
|
# description of each key as a guidance to specify the inputs during
|
8457
8476
|
# runtime when creating a job.
|
8458
8477
|
#
|
8478
|
+
# <note markdown="1"> `documentParameters` can only be used when creating jobs from Amazon
|
8479
|
+
# Web Services managed templates. This parameter can't be used with
|
8480
|
+
# custom job templates or to create jobs from them.
|
8481
|
+
#
|
8482
|
+
# </note>
|
8483
|
+
#
|
8459
8484
|
# @!attribute [rw] key
|
8460
8485
|
# Key of the map field containing the patterns that need to be
|
8461
8486
|
# replaced in a managed template job document schema.
|
@@ -10105,6 +10130,13 @@ module Aws::IoT
|
|
10105
10130
|
# will run on a device when the thing representing the device is added
|
10106
10131
|
# to a target group, even after the job was completed by all things
|
10107
10132
|
# originally in the group.
|
10133
|
+
#
|
10134
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs
|
10135
|
+
# for dynamic thing group targets. By using continuous jobs, devices
|
10136
|
+
# that join the group receive the job execution even after the job has
|
10137
|
+
# been created.
|
10138
|
+
#
|
10139
|
+
# </note>
|
10108
10140
|
# @return [String]
|
10109
10141
|
#
|
10110
10142
|
# @!attribute [rw] status
|
@@ -10197,8 +10229,17 @@ module Aws::IoT
|
|
10197
10229
|
# a managed template job document schema. You can use the description
|
10198
10230
|
# of each key as a guidance to specify the inputs during runtime when
|
10199
10231
|
# creating a job.
|
10232
|
+
#
|
10233
|
+
# <note markdown="1"> `documentParameters` can only be used when creating jobs from Amazon
|
10234
|
+
# Web Services managed templates. This parameter can't be used with
|
10235
|
+
# custom job templates or to create jobs from them.
|
10236
|
+
#
|
10237
|
+
# </note>
|
10200
10238
|
# @return [Hash<String,String>]
|
10201
10239
|
#
|
10240
|
+
# @!attribute [rw] is_concurrent
|
10241
|
+
# @return [Boolean]
|
10242
|
+
#
|
10202
10243
|
class Job < Struct.new(
|
10203
10244
|
:job_arn,
|
10204
10245
|
:job_id,
|
@@ -10220,7 +10261,8 @@ module Aws::IoT
|
|
10220
10261
|
:namespace_id,
|
10221
10262
|
:job_template_arn,
|
10222
10263
|
:job_executions_retry_config,
|
10223
|
-
:document_parameters
|
10264
|
+
:document_parameters,
|
10265
|
+
:is_concurrent)
|
10224
10266
|
SENSITIVE = []
|
10225
10267
|
include Aws::Structure
|
10226
10268
|
end
|
@@ -10531,6 +10573,13 @@ module Aws::IoT
|
|
10531
10573
|
# on a thing when a change is detected in a target. For example, a job
|
10532
10574
|
# will run on a thing when the thing is added to a target group, even
|
10533
10575
|
# after the job was completed by all things originally in the group.
|
10576
|
+
#
|
10577
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs
|
10578
|
+
# for dynamic thing group targets. By using continuous jobs, devices
|
10579
|
+
# that join the group receive the job execution even after the job has
|
10580
|
+
# been created.
|
10581
|
+
#
|
10582
|
+
# </note>
|
10534
10583
|
# @return [String]
|
10535
10584
|
#
|
10536
10585
|
# @!attribute [rw] status
|
@@ -10549,6 +10598,9 @@ module Aws::IoT
|
|
10549
10598
|
# The time, in seconds since the epoch, when the job completed.
|
10550
10599
|
# @return [Time]
|
10551
10600
|
#
|
10601
|
+
# @!attribute [rw] is_concurrent
|
10602
|
+
# @return [Boolean]
|
10603
|
+
#
|
10552
10604
|
class JobSummary < Struct.new(
|
10553
10605
|
:job_arn,
|
10554
10606
|
:job_id,
|
@@ -10557,7 +10609,8 @@ module Aws::IoT
|
|
10557
10609
|
:status,
|
10558
10610
|
:created_at,
|
10559
10611
|
:last_updated_at,
|
10560
|
-
:completed_at
|
10612
|
+
:completed_at,
|
10613
|
+
:is_concurrent)
|
10561
10614
|
SENSITIVE = []
|
10562
10615
|
include Aws::Structure
|
10563
10616
|
end
|
@@ -12000,6 +12053,13 @@ module Aws::IoT
|
|
12000
12053
|
# on a thing when a change is detected in a target. For example, a job
|
12001
12054
|
# will run on a thing when the thing is added to a target group, even
|
12002
12055
|
# after the job was completed by all things originally in the group.
|
12056
|
+
#
|
12057
|
+
# <note markdown="1"> We recommend that you use continuous jobs instead of snapshot jobs
|
12058
|
+
# for dynamic thing group targets. By using continuous jobs, devices
|
12059
|
+
# that join the group receive the job execution even after the job has
|
12060
|
+
# been created.
|
12061
|
+
#
|
12062
|
+
# </note>
|
12003
12063
|
# @return [String]
|
12004
12064
|
#
|
12005
12065
|
# @!attribute [rw] max_results
|
@@ -12108,6 +12168,84 @@ module Aws::IoT
|
|
12108
12168
|
include Aws::Structure
|
12109
12169
|
end
|
12110
12170
|
|
12171
|
+
# @note When making an API call, you may pass ListMetricValuesRequest
|
12172
|
+
# data as a hash:
|
12173
|
+
#
|
12174
|
+
# {
|
12175
|
+
# thing_name: "DeviceDefenderThingName", # required
|
12176
|
+
# metric_name: "BehaviorMetric", # required
|
12177
|
+
# dimension_name: "DimensionName",
|
12178
|
+
# dimension_value_operator: "IN", # accepts IN, NOT_IN
|
12179
|
+
# start_time: Time.now, # required
|
12180
|
+
# end_time: Time.now, # required
|
12181
|
+
# max_results: 1,
|
12182
|
+
# next_token: "NextToken",
|
12183
|
+
# }
|
12184
|
+
#
|
12185
|
+
# @!attribute [rw] thing_name
|
12186
|
+
# The name of the thing for which security profile metric values are
|
12187
|
+
# returned.
|
12188
|
+
# @return [String]
|
12189
|
+
#
|
12190
|
+
# @!attribute [rw] metric_name
|
12191
|
+
# The name of the security profile metric for which values are
|
12192
|
+
# returned.
|
12193
|
+
# @return [String]
|
12194
|
+
#
|
12195
|
+
# @!attribute [rw] dimension_name
|
12196
|
+
# The dimension name.
|
12197
|
+
# @return [String]
|
12198
|
+
#
|
12199
|
+
# @!attribute [rw] dimension_value_operator
|
12200
|
+
# The dimension value operator.
|
12201
|
+
# @return [String]
|
12202
|
+
#
|
12203
|
+
# @!attribute [rw] start_time
|
12204
|
+
# The start of the time period for which metric values are returned.
|
12205
|
+
# @return [Time]
|
12206
|
+
#
|
12207
|
+
# @!attribute [rw] end_time
|
12208
|
+
# The end of the time period for which metric values are returned.
|
12209
|
+
# @return [Time]
|
12210
|
+
#
|
12211
|
+
# @!attribute [rw] max_results
|
12212
|
+
# The maximum number of results to return at one time.
|
12213
|
+
# @return [Integer]
|
12214
|
+
#
|
12215
|
+
# @!attribute [rw] next_token
|
12216
|
+
# The token for the next set of results.
|
12217
|
+
# @return [String]
|
12218
|
+
#
|
12219
|
+
class ListMetricValuesRequest < Struct.new(
|
12220
|
+
:thing_name,
|
12221
|
+
:metric_name,
|
12222
|
+
:dimension_name,
|
12223
|
+
:dimension_value_operator,
|
12224
|
+
:start_time,
|
12225
|
+
:end_time,
|
12226
|
+
:max_results,
|
12227
|
+
:next_token)
|
12228
|
+
SENSITIVE = []
|
12229
|
+
include Aws::Structure
|
12230
|
+
end
|
12231
|
+
|
12232
|
+
# @!attribute [rw] metric_datum_list
|
12233
|
+
# The data the thing reports for the metric during the specified time
|
12234
|
+
# period.
|
12235
|
+
# @return [Array<Types::MetricDatum>]
|
12236
|
+
#
|
12237
|
+
# @!attribute [rw] next_token
|
12238
|
+
# A token that can be used to retrieve the next set of results, or
|
12239
|
+
# `null` if there are no additional results.
|
12240
|
+
# @return [String]
|
12241
|
+
#
|
12242
|
+
class ListMetricValuesResponse < Struct.new(
|
12243
|
+
:metric_datum_list,
|
12244
|
+
:next_token)
|
12245
|
+
SENSITIVE = []
|
12246
|
+
include Aws::Structure
|
12247
|
+
end
|
12248
|
+
|
12111
12249
|
# @note When making an API call, you may pass ListMitigationActionsRequest
|
12112
12250
|
# data as a hash:
|
12113
12251
|
#
|
@@ -13792,6 +13930,23 @@ module Aws::IoT
|
|
13792
13930
|
include Aws::Structure
|
13793
13931
|
end
|
13794
13932
|
|
13933
|
+
# A metric.
|
13934
|
+
#
|
13935
|
+
# @!attribute [rw] timestamp
|
13936
|
+
# The time the metric value was reported.
|
13937
|
+
# @return [Time]
|
13938
|
+
#
|
13939
|
+
# @!attribute [rw] value
|
13940
|
+
# The value reported for the metric.
|
13941
|
+
# @return [Types::MetricValue]
|
13942
|
+
#
|
13943
|
+
class MetricDatum < Struct.new(
|
13944
|
+
:timestamp,
|
13945
|
+
:value)
|
13946
|
+
SENSITIVE = []
|
13947
|
+
include Aws::Structure
|
13948
|
+
end
|
13949
|
+
|
13795
13950
|
# The dimension of a metric.
|
13796
13951
|
#
|
13797
13952
|
# @note When making an API call, you may pass MetricDimension
|
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.90.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-05-12 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|