aws-sdk-iot 1.71.0 → 1.75.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -60,8 +60,8 @@ module Aws::IoT
60
60
  # The minimum percentage of job execution failures that must occur to
61
61
  # initiate the job abort.
62
62
  #
63
- # AWS IoT supports up to two digits after the decimal (for example,
64
- # 10.9 and 10.99, but not 10.999).
63
+ # Amazon Web Services IoT Core supports up to two digits after the
64
+ # decimal (for example, 10.9 and 10.99, but not 10.999).
65
65
  # @return [Float]
66
66
  #
67
67
  # @!attribute [rw] min_number_of_executed_things
@@ -276,6 +276,13 @@ module Aws::IoT
276
276
  # "String" => "String",
277
277
  # },
278
278
  # },
279
+ # open_search: {
280
+ # role_arn: "AwsArn", # required
281
+ # endpoint: "ElasticsearchEndpoint", # required
282
+ # index: "ElasticsearchIndex", # required
283
+ # type: "ElasticsearchType", # required
284
+ # id: "ElasticsearchId", # required
285
+ # },
279
286
  # }
280
287
  #
281
288
  # @!attribute [rw] dynamo_db
@@ -330,6 +337,14 @@ module Aws::IoT
330
337
  #
331
338
  # @!attribute [rw] elasticsearch
332
339
  # Write data to an Amazon Elasticsearch Service domain.
340
+ #
341
+ # <note markdown="1"> This action is deprecated. Use the [OpenSearch action][1] instead.
342
+ #
343
+ # </note>
344
+ #
345
+ #
346
+ #
347
+ # [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html
333
348
  # @return [Types::ElasticsearchAction]
334
349
  #
335
350
  # @!attribute [rw] salesforce
@@ -337,15 +352,15 @@ module Aws::IoT
337
352
  # @return [Types::SalesforceAction]
338
353
  #
339
354
  # @!attribute [rw] iot_analytics
340
- # Sends message data to an AWS IoT Analytics channel.
355
+ # Sends message data to an IoT Analytics channel.
341
356
  # @return [Types::IotAnalyticsAction]
342
357
  #
343
358
  # @!attribute [rw] iot_events
344
- # Sends an input to an AWS IoT Events detector.
359
+ # Sends an input to an IoT Events detector.
345
360
  # @return [Types::IotEventsAction]
346
361
  #
347
362
  # @!attribute [rw] iot_site_wise
348
- # Sends data from the MQTT message that triggered the rule to AWS IoT
363
+ # Sends data from the MQTT message that triggered the rule to IoT
349
364
  # SiteWise asset properties.
350
365
  # @return [Types::IotSiteWiseAction]
351
366
  #
@@ -372,6 +387,10 @@ module Aws::IoT
372
387
  # (Amazon MSK) or self-managed Apache Kafka cluster.
373
388
  # @return [Types::KafkaAction]
374
389
  #
390
+ # @!attribute [rw] open_search
391
+ # Write data to an Amazon OpenSearch Service domain.
392
+ # @return [Types::OpenSearchAction]
393
+ #
375
394
  class Action < Struct.new(
376
395
  :dynamo_db,
377
396
  :dynamo_d_bv_2,
@@ -393,7 +412,8 @@ module Aws::IoT
393
412
  :step_functions,
394
413
  :timestream,
395
414
  :http,
396
- :kafka)
415
+ :kafka,
416
+ :open_search)
397
417
  SENSITIVE = []
398
418
  include Aws::Structure
399
419
  end
@@ -561,6 +581,31 @@ module Aws::IoT
561
581
  include Aws::Structure
562
582
  end
563
583
 
584
+ # The type of aggregation queries.
585
+ #
586
+ # @note When making an API call, you may pass AggregationType
587
+ # data as a hash:
588
+ #
589
+ # {
590
+ # name: "Statistics", # required, accepts Statistics, Percentiles, Cardinality
591
+ # values: ["AggregationTypeValue"],
592
+ # }
593
+ #
594
+ # @!attribute [rw] name
595
+ # The name of the aggregation type.
596
+ # @return [String]
597
+ #
598
+ # @!attribute [rw] values
599
+ # A list of the values of aggregation types.
600
+ # @return [Array<String>]
601
+ #
602
+ class AggregationType < Struct.new(
603
+ :name,
604
+ :values)
605
+ SENSITIVE = []
606
+ include Aws::Structure
607
+ end
608
+
564
609
  # A structure containing the alert target ARN and the role ARN.
565
610
  #
566
611
  # @note When making an API call, you may pass AlertTarget
@@ -735,9 +780,9 @@ module Aws::IoT
735
780
  # @!attribute [rw] namespace_id
736
781
  # The namespace used to indicate that a job is a customer-managed job.
737
782
  #
738
- # When you specify a value for this parameter, AWS IoT Core sends jobs
739
- # notifications to MQTT topics that contain the value in the following
740
- # format.
783
+ # When you specify a value for this parameter, Amazon Web Services IoT
784
+ # Core sends jobs notifications to MQTT topics that contain the value
785
+ # in the following format.
741
786
  #
742
787
  # `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
743
788
  #
@@ -1396,7 +1441,7 @@ module Aws::IoT
1396
1441
  # @return [Time]
1397
1442
  #
1398
1443
  # @!attribute [rw] signing_disabled
1399
- # Specifies whether AWS IoT validates the token signature in an
1444
+ # Specifies whether IoT validates the token signature in an
1400
1445
  # authorization request.
1401
1446
  # @return [Boolean]
1402
1447
  #
@@ -1481,8 +1526,8 @@ module Aws::IoT
1481
1526
  # The minimum percentage of job execution failures that must occur to
1482
1527
  # initiate the job abort.
1483
1528
  #
1484
- # AWS IoT supports up to two digits after the decimal (for example,
1485
- # 10.9 and 10.99, but not 10.999).
1529
+ # Amazon Web Services IoT Core supports up to two digits after the
1530
+ # decimal (for example, 10.9 and 10.99, but not 10.999).
1486
1531
  # @return [Float]
1487
1532
  #
1488
1533
  # @!attribute [rw] min_number_of_executed_things
@@ -1561,8 +1606,8 @@ module Aws::IoT
1561
1606
  # @!attribute [rw] rate_increase_criteria
1562
1607
  # The criteria to initiate the increase in rate of rollout for a job.
1563
1608
  #
1564
- # AWS IoT supports up to one digit after the decimal (for example,
1565
- # 1.5, but not 1.55).
1609
+ # Amazon Web Services IoT Core supports up to one digit after the
1610
+ # decimal (for example, 1.5, but not 1.55).
1566
1611
  # @return [Types::AwsJobRateIncreaseCriteria]
1567
1612
  #
1568
1613
  class AwsJobExponentialRolloutRate < Struct.new(
@@ -1879,6 +1924,47 @@ module Aws::IoT
1879
1924
  include Aws::Structure
1880
1925
  end
1881
1926
 
1927
+ # A count of documents that meets a specific aggregation criteria.
1928
+ #
1929
+ # @!attribute [rw] key_value
1930
+ # The value counted for the particular bucket.
1931
+ # @return [String]
1932
+ #
1933
+ # @!attribute [rw] count
1934
+ # The number of documents that have the value counted for the
1935
+ # particular bucket.
1936
+ # @return [Integer]
1937
+ #
1938
+ class Bucket < Struct.new(
1939
+ :key_value,
1940
+ :count)
1941
+ SENSITIVE = []
1942
+ include Aws::Structure
1943
+ end
1944
+
1945
+ # The type of bucketed aggregation performed.
1946
+ #
1947
+ # @note When making an API call, you may pass BucketsAggregationType
1948
+ # data as a hash:
1949
+ #
1950
+ # {
1951
+ # terms_aggregation: {
1952
+ # max_buckets: 1,
1953
+ # },
1954
+ # }
1955
+ #
1956
+ # @!attribute [rw] terms_aggregation
1957
+ # Performs an aggregation that will return a list of buckets. The list
1958
+ # of buckets is a ranked list of the number of occurrences of an
1959
+ # aggregation field value.
1960
+ # @return [Types::TermsAggregation]
1961
+ #
1962
+ class BucketsAggregationType < Struct.new(
1963
+ :terms_aggregation)
1964
+ SENSITIVE = []
1965
+ include Aws::Structure
1966
+ end
1967
+
1882
1968
  # A CA certificate.
1883
1969
  #
1884
1970
  # @!attribute [rw] certificate_arn
@@ -2249,11 +2335,12 @@ module Aws::IoT
2249
2335
  # @return [String]
2250
2336
  #
2251
2337
  # @!attribute [rw] owned_by
2252
- # The ID of the AWS account that owns the certificate.
2338
+ # The ID of the Amazon Web Services account that owns the certificate.
2253
2339
  # @return [String]
2254
2340
  #
2255
2341
  # @!attribute [rw] previous_owned_by
2256
- # The ID of the AWS account of the previous owner of the certificate.
2342
+ # The ID of the Amazon Web Services account of the previous owner of
2343
+ # the certificate.
2257
2344
  # @return [String]
2258
2345
  #
2259
2346
  # @!attribute [rw] creation_date
@@ -2505,7 +2592,7 @@ module Aws::IoT
2505
2592
  # }
2506
2593
  #
2507
2594
  # @!attribute [rw] aws_signer_job_id
2508
- # The ID of the AWSSignerJob which was created to sign the file.
2595
+ # The ID of the `AWSSignerJob` which was created to sign the file.
2509
2596
  # @return [String]
2510
2597
  #
2511
2598
  # @!attribute [rw] start_signing_job_parameter
@@ -2759,7 +2846,7 @@ module Aws::IoT
2759
2846
  # @return [Array<Types::Tag>]
2760
2847
  #
2761
2848
  # @!attribute [rw] signing_disabled
2762
- # Specifies whether AWS IoT validates the token signature in an
2849
+ # Specifies whether IoT validates the token signature in an
2763
2850
  # authorization request.
2764
2851
  # @return [Boolean]
2765
2852
  #
@@ -2936,8 +3023,9 @@ module Aws::IoT
2936
3023
  # @!attribute [rw] client_request_token
2937
3024
  # Each custom metric must have a unique client request token. If you
2938
3025
  # try to create a new custom metric that already exists with a
2939
- # different token, an exception occurs. If you omit this value, AWS
2940
- # SDKs will automatically generate a unique client request.
3026
+ # different token, an exception occurs. If you omit this value, Amazon
3027
+ # Web Services SDKs will automatically generate a unique client
3028
+ # request.
2941
3029
  #
2942
3030
  # **A suitable default value is auto-generated.** You should normally
2943
3031
  # not need to pass this option.
@@ -3008,8 +3096,9 @@ module Aws::IoT
3008
3096
  # @!attribute [rw] client_request_token
3009
3097
  # Each dimension must have a unique client request token. If you try
3010
3098
  # to create a new dimension with the same token as a dimension that
3011
- # already exists, an exception occurs. If you omit this value, AWS
3012
- # SDKs will automatically generate a unique client request.
3099
+ # already exists, an exception occurs. If you omit this value, Amazon
3100
+ # Web Services SDKs will automatically generate a unique client
3101
+ # request.
3013
3102
  #
3014
3103
  # **A suitable default value is auto-generated.** You should normally
3015
3104
  # not need to pass this option.
@@ -3071,16 +3160,17 @@ module Aws::IoT
3071
3160
  # @return [String]
3072
3161
  #
3073
3162
  # @!attribute [rw] server_certificate_arns
3074
- # The ARNs of the certificates that AWS IoT passes to the device
3075
- # during the TLS handshake. Currently you can specify only one
3076
- # certificate ARN. This value is not required for AWS-managed domains.
3163
+ # The ARNs of the certificates that IoT passes to the device during
3164
+ # the TLS handshake. Currently you can specify only one certificate
3165
+ # ARN. This value is not required for Amazon Web Services-managed
3166
+ # domains.
3077
3167
  # @return [Array<String>]
3078
3168
  #
3079
3169
  # @!attribute [rw] validation_certificate_arn
3080
3170
  # The certificate used to validate the server certificate and prove
3081
3171
  # domain name ownership. This certificate must be signed by a public
3082
- # certificate authority. This value is not required for AWS-managed
3083
- # domains.
3172
+ # certificate authority. This value is not required for Amazon Web
3173
+ # Services-managed domains.
3084
3174
  # @return [String]
3085
3175
  #
3086
3176
  # @!attribute [rw] authorizer_config
@@ -3090,7 +3180,8 @@ module Aws::IoT
3090
3180
  # @!attribute [rw] service_type
3091
3181
  # The type of service delivered by the endpoint.
3092
3182
  #
3093
- # <note markdown="1"> AWS IoT Core currently supports only the `DATA` service type.
3183
+ # <note markdown="1"> Amazon Web Services IoT Core currently supports only the `DATA`
3184
+ # service type.
3094
3185
  #
3095
3186
  # </note>
3096
3187
  # @return [String]
@@ -3173,7 +3264,7 @@ module Aws::IoT
3173
3264
  # @!attribute [rw] index_name
3174
3265
  # The dynamic thing group index name.
3175
3266
  #
3176
- # <note markdown="1"> Currently one index is supported: "AWS\_Things".
3267
+ # <note markdown="1"> Currently one index is supported: `AWS_Things`.
3177
3268
  #
3178
3269
  # </note>
3179
3270
  # @return [String]
@@ -3247,6 +3338,106 @@ module Aws::IoT
3247
3338
  include Aws::Structure
3248
3339
  end
3249
3340
 
3341
+ # @note When making an API call, you may pass CreateFleetMetricRequest
3342
+ # data as a hash:
3343
+ #
3344
+ # {
3345
+ # metric_name: "FleetMetricName", # required
3346
+ # query_string: "QueryString", # required
3347
+ # aggregation_type: { # required
3348
+ # name: "Statistics", # required, accepts Statistics, Percentiles, Cardinality
3349
+ # values: ["AggregationTypeValue"],
3350
+ # },
3351
+ # period: 1, # required
3352
+ # aggregation_field: "AggregationField", # required
3353
+ # description: "FleetMetricDescription",
3354
+ # query_version: "QueryVersion",
3355
+ # index_name: "IndexName",
3356
+ # unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
3357
+ # tags: [
3358
+ # {
3359
+ # key: "TagKey", # required
3360
+ # value: "TagValue",
3361
+ # },
3362
+ # ],
3363
+ # }
3364
+ #
3365
+ # @!attribute [rw] metric_name
3366
+ # The name of the fleet metric to create.
3367
+ # @return [String]
3368
+ #
3369
+ # @!attribute [rw] query_string
3370
+ # The search query string.
3371
+ # @return [String]
3372
+ #
3373
+ # @!attribute [rw] aggregation_type
3374
+ # The type of the aggregation query.
3375
+ # @return [Types::AggregationType]
3376
+ #
3377
+ # @!attribute [rw] period
3378
+ # The time in seconds between fleet metric emissions. Range \[60(1
3379
+ # min), 86400(1 day)\] and must be multiple of 60.
3380
+ # @return [Integer]
3381
+ #
3382
+ # @!attribute [rw] aggregation_field
3383
+ # The field to aggregate.
3384
+ # @return [String]
3385
+ #
3386
+ # @!attribute [rw] description
3387
+ # The fleet metric description.
3388
+ # @return [String]
3389
+ #
3390
+ # @!attribute [rw] query_version
3391
+ # The query version.
3392
+ # @return [String]
3393
+ #
3394
+ # @!attribute [rw] index_name
3395
+ # The name of the index to search.
3396
+ # @return [String]
3397
+ #
3398
+ # @!attribute [rw] unit
3399
+ # Used to support unit transformation such as milliseconds to seconds.
3400
+ # The unit must be supported by [CW metric][1]. Default to null.
3401
+ #
3402
+ #
3403
+ #
3404
+ # [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
3405
+ # @return [String]
3406
+ #
3407
+ # @!attribute [rw] tags
3408
+ # Metadata, which can be used to manage the fleet metric.
3409
+ # @return [Array<Types::Tag>]
3410
+ #
3411
+ class CreateFleetMetricRequest < Struct.new(
3412
+ :metric_name,
3413
+ :query_string,
3414
+ :aggregation_type,
3415
+ :period,
3416
+ :aggregation_field,
3417
+ :description,
3418
+ :query_version,
3419
+ :index_name,
3420
+ :unit,
3421
+ :tags)
3422
+ SENSITIVE = []
3423
+ include Aws::Structure
3424
+ end
3425
+
3426
+ # @!attribute [rw] metric_name
3427
+ # The name of the fleet metric to create.
3428
+ # @return [String]
3429
+ #
3430
+ # @!attribute [rw] metric_arn
3431
+ # The Amazon Resource Name (ARN) of the new fleet metric.
3432
+ # @return [String]
3433
+ #
3434
+ class CreateFleetMetricResponse < Struct.new(
3435
+ :metric_name,
3436
+ :metric_arn)
3437
+ SENSITIVE = []
3438
+ include Aws::Structure
3439
+ end
3440
+
3250
3441
  # @note When making an API call, you may pass CreateJobRequest
3251
3442
  # data as a hash:
3252
3443
  #
@@ -3296,9 +3487,9 @@ module Aws::IoT
3296
3487
  # }
3297
3488
  #
3298
3489
  # @!attribute [rw] job_id
3299
- # A job identifier which must be unique for your AWS account. We
3300
- # recommend using a UUID. Alpha-numeric characters, "-" and "\_"
3301
- # are valid for use here.
3490
+ # A job identifier which must be unique for your Amazon Web Services
3491
+ # account. We recommend using a UUID. Alpha-numeric characters, "-"
3492
+ # and "\_" are valid for use here.
3302
3493
  # @return [String]
3303
3494
  #
3304
3495
  # @!attribute [rw] targets
@@ -3367,9 +3558,9 @@ module Aws::IoT
3367
3558
  # @!attribute [rw] namespace_id
3368
3559
  # The namespace used to indicate that a job is a customer-managed job.
3369
3560
  #
3370
- # When you specify a value for this parameter, AWS IoT Core sends jobs
3371
- # notifications to MQTT topics that contain the value in the following
3372
- # format.
3561
+ # When you specify a value for this parameter, Amazon Web Services IoT
3562
+ # Core sends jobs notifications to MQTT topics that contain the value
3563
+ # in the following format.
3373
3564
  #
3374
3565
  # `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
3375
3566
  #
@@ -3556,6 +3747,13 @@ module Aws::IoT
3556
3747
 
3557
3748
  # The input for the CreateKeysAndCertificate operation.
3558
3749
  #
3750
+ # Requires permission to access the [CreateKeysAndCertificateRequest][1]
3751
+ # action.
3752
+ #
3753
+ #
3754
+ #
3755
+ # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
3756
+ #
3559
3757
  # @note When making an API call, you may pass CreateKeysAndCertificateRequest
3560
3758
  # data as a hash:
3561
3759
  #
@@ -3580,8 +3778,8 @@ module Aws::IoT
3580
3778
  # @return [String]
3581
3779
  #
3582
3780
  # @!attribute [rw] certificate_id
3583
- # The ID of the certificate. AWS IoT issues a default subject name for
3584
- # the certificate (for example, AWS IoT Certificate).
3781
+ # The ID of the certificate. IoT issues a default subject name for the
3782
+ # certificate (for example, IoT Certificate).
3585
3783
  # @return [String]
3586
3784
  #
3587
3785
  # @!attribute [rw] certificate_pem
@@ -3829,8 +4027,9 @@ module Aws::IoT
3829
4027
  # @return [Array<Types::OTAUpdateFile>]
3830
4028
  #
3831
4029
  # @!attribute [rw] role_arn
3832
- # The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT
3833
- # jobs and AWS Code Signing resources to create an OTA update job.
4030
+ # The IAM role that grants Amazon Web Services IoT Core access to the
4031
+ # Amazon S3, IoT jobs and Amazon Web Services Code Signing resources
4032
+ # to create an OTA update job.
3834
4033
  # @return [String]
3835
4034
  #
3836
4035
  # @!attribute [rw] additional_parameters
@@ -3865,7 +4064,7 @@ module Aws::IoT
3865
4064
  # @return [String]
3866
4065
  #
3867
4066
  # @!attribute [rw] aws_iot_job_id
3868
- # The AWS IoT job ID associated with the OTA update.
4067
+ # The IoT job ID associated with the OTA update.
3869
4068
  # @return [String]
3870
4069
  #
3871
4070
  # @!attribute [rw] ota_update_arn
@@ -3873,7 +4072,7 @@ module Aws::IoT
3873
4072
  # @return [String]
3874
4073
  #
3875
4074
  # @!attribute [rw] aws_iot_job_arn
3876
- # The AWS IoT job ARN associated with the OTA update.
4075
+ # The IoT job ARN associated with the OTA update.
3877
4076
  # @return [String]
3878
4077
  #
3879
4078
  # @!attribute [rw] ota_update_status
@@ -4244,7 +4443,8 @@ module Aws::IoT
4244
4443
  # @return [String]
4245
4444
  #
4246
4445
  # @!attribute [rw] credential_duration_seconds
4247
- # How long (in seconds) the credentials will be valid.
4446
+ # How long (in seconds) the credentials will be valid. The default
4447
+ # value is 3,600 seconds.
4248
4448
  # @return [Integer]
4249
4449
  #
4250
4450
  # @!attribute [rw] tags
@@ -4988,6 +5188,13 @@ module Aws::IoT
4988
5188
  # "String" => "String",
4989
5189
  # },
4990
5190
  # },
5191
+ # open_search: {
5192
+ # role_arn: "AwsArn", # required
5193
+ # endpoint: "ElasticsearchEndpoint", # required
5194
+ # index: "ElasticsearchIndex", # required
5195
+ # type: "ElasticsearchType", # required
5196
+ # id: "ElasticsearchId", # required
5197
+ # },
4991
5198
  # },
4992
5199
  # ],
4993
5200
  # rule_disabled: false,
@@ -5159,6 +5366,13 @@ module Aws::IoT
5159
5366
  # "String" => "String",
5160
5367
  # },
5161
5368
  # },
5369
+ # open_search: {
5370
+ # role_arn: "AwsArn", # required
5371
+ # endpoint: "ElasticsearchEndpoint", # required
5372
+ # index: "ElasticsearchIndex", # required
5373
+ # type: "ElasticsearchType", # required
5374
+ # id: "ElasticsearchId", # required
5375
+ # },
5162
5376
  # },
5163
5377
  # },
5164
5378
  # tags: "String",
@@ -5490,6 +5704,29 @@ module Aws::IoT
5490
5704
 
5491
5705
  class DeleteDynamicThingGroupResponse < Aws::EmptyStructure; end
5492
5706
 
5707
+ # @note When making an API call, you may pass DeleteFleetMetricRequest
5708
+ # data as a hash:
5709
+ #
5710
+ # {
5711
+ # metric_name: "FleetMetricName", # required
5712
+ # expected_version: 1,
5713
+ # }
5714
+ #
5715
+ # @!attribute [rw] metric_name
5716
+ # The name of the fleet metric to delete.
5717
+ # @return [String]
5718
+ #
5719
+ # @!attribute [rw] expected_version
5720
+ # The expected version of the fleet metric to delete.
5721
+ # @return [Integer]
5722
+ #
5723
+ class DeleteFleetMetricRequest < Struct.new(
5724
+ :metric_name,
5725
+ :expected_version)
5726
+ SENSITIVE = []
5727
+ include Aws::Structure
5728
+ end
5729
+
5493
5730
  # @note When making an API call, you may pass DeleteJobExecutionRequest
5494
5731
  # data as a hash:
5495
5732
  #
@@ -5536,9 +5773,9 @@ module Aws::IoT
5536
5773
  # @!attribute [rw] namespace_id
5537
5774
  # The namespace used to indicate that a job is a customer-managed job.
5538
5775
  #
5539
- # When you specify a value for this parameter, AWS IoT Core sends jobs
5540
- # notifications to MQTT topics that contain the value in the following
5541
- # format.
5776
+ # When you specify a value for this parameter, Amazon Web Services IoT
5777
+ # Core sends jobs notifications to MQTT topics that contain the value
5778
+ # in the following format.
5542
5779
  #
5543
5780
  # `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
5544
5781
  #
@@ -5593,9 +5830,9 @@ module Aws::IoT
5593
5830
  # @!attribute [rw] namespace_id
5594
5831
  # The namespace used to indicate that a job is a customer-managed job.
5595
5832
  #
5596
- # When you specify a value for this parameter, AWS IoT Core sends jobs
5597
- # notifications to MQTT topics that contain the value in the following
5598
- # format.
5833
+ # When you specify a value for this parameter, Amazon Web Services IoT
5834
+ # Core sends jobs notifications to MQTT topics that contain the value
5835
+ # in the following format.
5599
5836
  #
5600
5837
  # `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
5601
5838
  #
@@ -5668,7 +5905,7 @@ module Aws::IoT
5668
5905
  # @return [Boolean]
5669
5906
  #
5670
5907
  # @!attribute [rw] force_delete_aws_job
5671
- # When true, deletes the AWS job created by the OTAUpdate process even
5908
+ # When true, deletes the IoT job created by the OTAUpdate process even
5672
5909
  # if it is "IN\_PROGRESS". Otherwise, if the job is not in a
5673
5910
  # terminal state ("COMPLETED" or "CANCELED") an exception will
5674
5911
  # occur. The default is false.
@@ -6064,7 +6301,7 @@ module Aws::IoT
6064
6301
  class DescribeAccountAuditConfigurationRequest < Aws::EmptyStructure; end
6065
6302
 
6066
6303
  # @!attribute [rw] role_arn
6067
- # The ARN of the role that grants permission to AWS IoT to access
6304
+ # The ARN of the role that grants permission to IoT to access
6068
6305
  # information about your devices, policies, certificates, and other
6069
6306
  # items as required when performing an audit.
6070
6307
  #
@@ -6696,14 +6933,13 @@ module Aws::IoT
6696
6933
  # ^
6697
6934
  # ^
6698
6935
  #
6699
- # * `iot:CredentialProvider` - Returns an AWS IoT credentials provider
6700
- # API endpoint.
6936
+ # * `iot:CredentialProvider` - Returns an IoT credentials provider API
6937
+ # endpoint.
6701
6938
  #
6702
6939
  # ^
6703
6940
  # ^
6704
6941
  #
6705
- # * `iot:Jobs` - Returns an AWS IoT device management Jobs API
6706
- # endpoint.
6942
+ # * `iot:Jobs` - Returns an IoT device management Jobs API endpoint.
6707
6943
  #
6708
6944
  # ^
6709
6945
  #
@@ -6755,6 +6991,99 @@ module Aws::IoT
6755
6991
  include Aws::Structure
6756
6992
  end
6757
6993
 
6994
+ # @note When making an API call, you may pass DescribeFleetMetricRequest
6995
+ # data as a hash:
6996
+ #
6997
+ # {
6998
+ # metric_name: "FleetMetricName", # required
6999
+ # }
7000
+ #
7001
+ # @!attribute [rw] metric_name
7002
+ # The name of the fleet metric to describe.
7003
+ # @return [String]
7004
+ #
7005
+ class DescribeFleetMetricRequest < Struct.new(
7006
+ :metric_name)
7007
+ SENSITIVE = []
7008
+ include Aws::Structure
7009
+ end
7010
+
7011
+ # @!attribute [rw] metric_name
7012
+ # The name of the fleet metric to describe.
7013
+ # @return [String]
7014
+ #
7015
+ # @!attribute [rw] query_string
7016
+ # The search query string.
7017
+ # @return [String]
7018
+ #
7019
+ # @!attribute [rw] aggregation_type
7020
+ # The type of the aggregation query.
7021
+ # @return [Types::AggregationType]
7022
+ #
7023
+ # @!attribute [rw] period
7024
+ # The time in seconds between fleet metric emissions. Range \[60(1
7025
+ # min), 86400(1 day)\] and must be multiple of 60.
7026
+ # @return [Integer]
7027
+ #
7028
+ # @!attribute [rw] aggregation_field
7029
+ # The field to aggregate.
7030
+ # @return [String]
7031
+ #
7032
+ # @!attribute [rw] description
7033
+ # The fleet metric description.
7034
+ # @return [String]
7035
+ #
7036
+ # @!attribute [rw] query_version
7037
+ # The query version.
7038
+ # @return [String]
7039
+ #
7040
+ # @!attribute [rw] index_name
7041
+ # The name of the index to search.
7042
+ # @return [String]
7043
+ #
7044
+ # @!attribute [rw] creation_date
7045
+ # The date when the fleet metric is created.
7046
+ # @return [Time]
7047
+ #
7048
+ # @!attribute [rw] last_modified_date
7049
+ # The date when the fleet metric is last modified.
7050
+ # @return [Time]
7051
+ #
7052
+ # @!attribute [rw] unit
7053
+ # Used to support unit transformation such as milliseconds to seconds.
7054
+ # The unit must be supported by [CW metric][1].
7055
+ #
7056
+ #
7057
+ #
7058
+ # [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
7059
+ # @return [String]
7060
+ #
7061
+ # @!attribute [rw] version
7062
+ # The version of the fleet metric.
7063
+ # @return [Integer]
7064
+ #
7065
+ # @!attribute [rw] metric_arn
7066
+ # The ARN of the fleet metric to describe.
7067
+ # @return [String]
7068
+ #
7069
+ class DescribeFleetMetricResponse < Struct.new(
7070
+ :metric_name,
7071
+ :query_string,
7072
+ :aggregation_type,
7073
+ :period,
7074
+ :aggregation_field,
7075
+ :description,
7076
+ :query_version,
7077
+ :index_name,
7078
+ :creation_date,
7079
+ :last_modified_date,
7080
+ :unit,
7081
+ :version,
7082
+ :metric_arn)
7083
+ SENSITIVE = []
7084
+ include Aws::Structure
7085
+ end
7086
+
6758
7087
  # @note When making an API call, you may pass DescribeIndexRequest
6759
7088
  # data as a hash:
6760
7089
  #
@@ -6997,8 +7326,8 @@ module Aws::IoT
6997
7326
  # @return [Types::MitigationActionParams]
6998
7327
  #
6999
7328
  # @!attribute [rw] creation_date
7000
- # The date and time when the mitigation action was added to your AWS
7001
- # account.
7329
+ # The date and time when the mitigation action was added to your
7330
+ # Amazon Web Services accounts.
7002
7331
  # @return [Time]
7003
7332
  #
7004
7333
  # @!attribute [rw] last_modified_date
@@ -7525,9 +7854,8 @@ module Aws::IoT
7525
7854
  # thing name and use it as the MQTT client ID for the registry and the
7526
7855
  # Device Shadow service.
7527
7856
  #
7528
- # This lets you better organize your AWS IoT fleet without removing
7529
- # the flexibility of the underlying device certificate model or
7530
- # shadows.
7857
+ # This lets you better organize your IoT fleet without removing the
7858
+ # flexibility of the underlying device certificate model or shadows.
7531
7859
  # @return [String]
7532
7860
  #
7533
7861
  # @!attribute [rw] thing_name
@@ -7951,9 +8279,9 @@ module Aws::IoT
7951
8279
 
7952
8280
  # The summary of a domain configuration. A domain configuration
7953
8281
  # specifies custom IoT-specific information about a domain. A domain
7954
- # configuration can be associated with an AWS-managed domain (for
7955
- # example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer
7956
- # managed domain, or a default endpoint.
8282
+ # configuration can be associated with an Amazon Web Services-managed
8283
+ # domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a
8284
+ # customer managed domain, or a default endpoint.
7957
8285
  #
7958
8286
  # * Data
7959
8287
  #
@@ -8136,6 +8464,14 @@ module Aws::IoT
8136
8464
  # Describes an action that writes data to an Amazon Elasticsearch
8137
8465
  # Service domain.
8138
8466
  #
8467
+ # <note markdown="1"> This action is deprecated. Use the [OpenSearch action][1] instead.
8468
+ #
8469
+ # </note>
8470
+ #
8471
+ #
8472
+ #
8473
+ # [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html
8474
+ #
8139
8475
  # @note When making an API call, you may pass ElasticsearchAction
8140
8476
  # data as a hash:
8141
8477
  #
@@ -8177,8 +8513,8 @@ module Aws::IoT
8177
8513
  include Aws::Structure
8178
8514
  end
8179
8515
 
8180
- # Parameters used when defining a mitigation action that enable AWS IoT
8181
- # logging.
8516
+ # Parameters used when defining a mitigation action that enable Amazon
8517
+ # Web Services IoT Core logging.
8182
8518
  #
8183
8519
  # @note When making an API call, you may pass EnableIoTLoggingParams
8184
8520
  # data as a hash:
@@ -8274,8 +8610,8 @@ module Aws::IoT
8274
8610
  # @!attribute [rw] increment_factor
8275
8611
  # The exponential factor to increase the rate of rollout for a job.
8276
8612
  #
8277
- # AWS IoT supports up to one digit after the decimal (for example,
8278
- # 1.5, but not 1.55).
8613
+ # Amazon Web Services IoT Core supports up to one digit after the
8614
+ # decimal (for example, 1.5, but not 1.55).
8279
8615
  # @return [Float]
8280
8616
  #
8281
8617
  # @!attribute [rw] rate_increase_criteria
@@ -8305,7 +8641,7 @@ module Aws::IoT
8305
8641
  # @return [String]
8306
8642
  #
8307
8643
  # @!attribute [rw] type
8308
- # The datatype of the field.
8644
+ # The data type of the field.
8309
8645
  # @return [String]
8310
8646
  #
8311
8647
  class Field < Struct.new(
@@ -8398,6 +8734,23 @@ module Aws::IoT
8398
8734
  include Aws::Structure
8399
8735
  end
8400
8736
 
8737
+ # The name and ARN of a fleet metric.
8738
+ #
8739
+ # @!attribute [rw] metric_name
8740
+ # The fleet metric name.
8741
+ # @return [String]
8742
+ #
8743
+ # @!attribute [rw] metric_arn
8744
+ # The fleet metric ARN.
8745
+ # @return [String]
8746
+ #
8747
+ class FleetMetricNameAndArn < Struct.new(
8748
+ :metric_name,
8749
+ :metric_arn)
8750
+ SENSITIVE = []
8751
+ include Aws::Structure
8752
+ end
8753
+
8401
8754
  # @note When making an API call, you may pass GetBehaviorModelTrainingSummariesRequest
8402
8755
  # data as a hash:
8403
8756
  #
@@ -8445,6 +8798,74 @@ module Aws::IoT
8445
8798
  include Aws::Structure
8446
8799
  end
8447
8800
 
8801
+ # @note When making an API call, you may pass GetBucketsAggregationRequest
8802
+ # data as a hash:
8803
+ #
8804
+ # {
8805
+ # index_name: "IndexName",
8806
+ # query_string: "QueryString", # required
8807
+ # aggregation_field: "AggregationField", # required
8808
+ # query_version: "QueryVersion",
8809
+ # buckets_aggregation_type: { # required
8810
+ # terms_aggregation: {
8811
+ # max_buckets: 1,
8812
+ # },
8813
+ # },
8814
+ # }
8815
+ #
8816
+ # @!attribute [rw] index_name
8817
+ # The name of the index to search.
8818
+ # @return [String]
8819
+ #
8820
+ # @!attribute [rw] query_string
8821
+ # The search query string.
8822
+ # @return [String]
8823
+ #
8824
+ # @!attribute [rw] aggregation_field
8825
+ # The aggregation field.
8826
+ # @return [String]
8827
+ #
8828
+ # @!attribute [rw] query_version
8829
+ # The version of the query.
8830
+ # @return [String]
8831
+ #
8832
+ # @!attribute [rw] buckets_aggregation_type
8833
+ # The basic control of the response shape and the bucket aggregation
8834
+ # type to perform.
8835
+ # @return [Types::BucketsAggregationType]
8836
+ #
8837
+ class GetBucketsAggregationRequest < Struct.new(
8838
+ :index_name,
8839
+ :query_string,
8840
+ :aggregation_field,
8841
+ :query_version,
8842
+ :buckets_aggregation_type)
8843
+ SENSITIVE = []
8844
+ include Aws::Structure
8845
+ end
8846
+
8847
+ # @!attribute [rw] total_count
8848
+ # The total number of documents that fit the query string criteria and
8849
+ # contain a value for the Aggregation field targeted in the request.
8850
+ # @return [Integer]
8851
+ #
8852
+ # @!attribute [rw] buckets
8853
+ # The main part of the response with a list of buckets. Each bucket
8854
+ # contains a `keyValue` and a `count`.
8855
+ #
8856
+ # `keyValue`\: The aggregation field value counted for the particular
8857
+ # bucket.
8858
+ #
8859
+ # `count`\: The number of documents that have that value.
8860
+ # @return [Array<Types::Bucket>]
8861
+ #
8862
+ class GetBucketsAggregationResponse < Struct.new(
8863
+ :total_count,
8864
+ :buckets)
8865
+ SENSITIVE = []
8866
+ include Aws::Structure
8867
+ end
8868
+
8448
8869
  # @note When making an API call, you may pass GetCardinalityRequest
8449
8870
  # data as a hash:
8450
8871
  #
@@ -8460,7 +8881,7 @@ module Aws::IoT
8460
8881
  # @return [String]
8461
8882
  #
8462
8883
  # @!attribute [rw] query_string
8463
- # The search query.
8884
+ # The search query string.
8464
8885
  # @return [String]
8465
8886
  #
8466
8887
  # @!attribute [rw] aggregation_field
@@ -8645,7 +9066,7 @@ module Aws::IoT
8645
9066
  # @return [String]
8646
9067
  #
8647
9068
  # @!attribute [rw] query_string
8648
- # The query string.
9069
+ # The search query string.
8649
9070
  # @return [String]
8650
9071
  #
8651
9072
  # @!attribute [rw] aggregation_field
@@ -8847,7 +9268,8 @@ module Aws::IoT
8847
9268
  #
8848
9269
  # @!attribute [rw] query_string
8849
9270
  # The query used to search. You can specify "*" for the query
8850
- # string to get the count of all indexed things in your AWS account.
9271
+ # string to get the count of all indexed things in your Amazon Web
9272
+ # Services account.
8851
9273
  # @return [String]
8852
9274
  #
8853
9275
  # @!attribute [rw] aggregation_field
@@ -8946,7 +9368,7 @@ module Aws::IoT
8946
9368
  class GetV2LoggingOptionsRequest < Aws::EmptyStructure; end
8947
9369
 
8948
9370
  # @!attribute [rw] role_arn
8949
- # The IAM role ARN AWS IoT uses to write to your CloudWatch logs.
9371
+ # The IAM role ARN IoT uses to write to your CloudWatch logs.
8950
9372
  # @return [String]
8951
9373
  #
8952
9374
  # @!attribute [rw] default_log_level
@@ -9012,9 +9434,9 @@ module Aws::IoT
9012
9434
  # @return [String]
9013
9435
  #
9014
9436
  # @!attribute [rw] confirmation_url
9015
- # The URL to which AWS IoT sends a confirmation message. The value of
9016
- # the confirmation URL must be a prefix of the endpoint URL. If you do
9017
- # not specify a confirmation URL AWS IoT uses the endpoint URL as the
9437
+ # The URL to which IoT sends a confirmation message. The value of the
9438
+ # confirmation URL must be a prefix of the endpoint URL. If you do not
9439
+ # specify a confirmation URL IoT uses the endpoint URL as the
9018
9440
  # confirmation URL. If you use substitution templates in the
9019
9441
  # confirmationUrl, you must create and enable topic rule destinations
9020
9442
  # that match each possible value of the substitution template before
@@ -9130,8 +9552,8 @@ module Aws::IoT
9130
9552
  # }
9131
9553
  #
9132
9554
  # @!attribute [rw] confirmation_url
9133
- # The URL AWS IoT uses to confirm ownership of or access to the topic
9134
- # rule destination URL.
9555
+ # The URL IoT uses to confirm ownership of or access to the topic rule
9556
+ # destination URL.
9135
9557
  # @return [String]
9136
9558
  #
9137
9559
  class HttpUrlDestinationConfiguration < Struct.new(
@@ -9277,7 +9699,7 @@ module Aws::IoT
9277
9699
  include Aws::Structure
9278
9700
  end
9279
9701
 
9280
- # Sends message data to an AWS IoT Analytics channel.
9702
+ # Sends message data to an IoT Analytics channel.
9281
9703
  #
9282
9704
  # @note When making an API call, you may pass IotAnalyticsAction
9283
9705
  # data as a hash:
@@ -9305,8 +9727,8 @@ module Aws::IoT
9305
9727
  #
9306
9728
  # When `batchMode` is `true` and the rule SQL statement evaluates to
9307
9729
  # an Array, each Array element is delivered as a separate message when
9308
- # passed by [ `BatchPutMessage` ][1] to the AWS IoT Analytics channel.
9309
- # The resulting array can't have more than 100 messages.
9730
+ # passed by [ `BatchPutMessage` ][1] to the IoT Analytics channel. The
9731
+ # resulting array can't have more than 100 messages.
9310
9732
  #
9311
9733
  #
9312
9734
  #
@@ -9328,7 +9750,7 @@ module Aws::IoT
9328
9750
  include Aws::Structure
9329
9751
  end
9330
9752
 
9331
- # Sends an input to an AWS IoT Events detector.
9753
+ # Sends an input to an IoT Events detector.
9332
9754
  #
9333
9755
  # @note When making an API call, you may pass IotEventsAction
9334
9756
  # data as a hash:
@@ -9341,7 +9763,7 @@ module Aws::IoT
9341
9763
  # }
9342
9764
  #
9343
9765
  # @!attribute [rw] input_name
9344
- # The name of the AWS IoT Events input.
9766
+ # The name of the IoT Events input.
9345
9767
  # @return [String]
9346
9768
  #
9347
9769
  # @!attribute [rw] message_id
@@ -9351,7 +9773,7 @@ module Aws::IoT
9351
9773
  # UUID value will be assigned.
9352
9774
  #
9353
9775
  # Assign a value to this property to ensure that only one input
9354
- # (message) with a given `messageId` will be processed by an AWS IoT
9776
+ # (message) with a given `messageId` will be processed by an IoT
9355
9777
  # Events detector.
9356
9778
  # @return [String]
9357
9779
  #
@@ -9363,8 +9785,8 @@ module Aws::IoT
9363
9785
  #
9364
9786
  # When `batchMode` is `true` and the rule SQL statement evaluates to
9365
9787
  # an Array, each Array element is treated as a separate message when
9366
- # it's sent to AWS IoT Events by calling [ `BatchPutMessage` ][1].
9367
- # The resulting array can't have more than 10 messages.
9788
+ # it's sent to IoT Events by calling [ `BatchPutMessage` ][1]. The
9789
+ # resulting array can't have more than 10 messages.
9368
9790
  #
9369
9791
  #
9370
9792
  #
@@ -9372,9 +9794,8 @@ module Aws::IoT
9372
9794
  # @return [Boolean]
9373
9795
  #
9374
9796
  # @!attribute [rw] role_arn
9375
- # The ARN of the role that grants AWS IoT permission to send an input
9376
- # to an AWS IoT Events detector.
9377
- # ("Action":"iotevents:BatchPutMessage").
9797
+ # The ARN of the role that grants IoT permission to send an input to
9798
+ # an IoT Events detector. ("Action":"iotevents:BatchPutMessage").
9378
9799
  # @return [String]
9379
9800
  #
9380
9801
  class IotEventsAction < Struct.new(
@@ -9387,7 +9808,7 @@ module Aws::IoT
9387
9808
  end
9388
9809
 
9389
9810
  # Describes an action to send data from an MQTT message that triggered
9390
- # the rule to AWS IoT SiteWise asset properties.
9811
+ # the rule to IoT SiteWise asset properties.
9391
9812
  #
9392
9813
  # @note When making an API call, you may pass IotSiteWiseAction
9393
9814
  # data as a hash:
@@ -9424,8 +9845,8 @@ module Aws::IoT
9424
9845
  # @return [Array<Types::PutAssetPropertyValueEntry>]
9425
9846
  #
9426
9847
  # @!attribute [rw] role_arn
9427
- # The ARN of the role that grants AWS IoT permission to send an asset
9428
- # property value to AWS IoTSiteWise. (`"Action":
9848
+ # The ARN of the role that grants IoT permission to send an asset
9849
+ # property value to IoT SiteWise. (`"Action":
9429
9850
  # "iotsitewise:BatchPutAssetPropertyValue"`). The trust policy can
9430
9851
  # restrict access to specific asset hierarchy paths.
9431
9852
  # @return [String]
@@ -9524,9 +9945,9 @@ module Aws::IoT
9524
9945
  # @!attribute [rw] namespace_id
9525
9946
  # The namespace used to indicate that a job is a customer-managed job.
9526
9947
  #
9527
- # When you specify a value for this parameter, AWS IoT Core sends jobs
9528
- # notifications to MQTT topics that contain the value in the following
9529
- # format.
9948
+ # When you specify a value for this parameter, Amazon Web Services IoT
9949
+ # Core sends jobs notifications to MQTT topics that contain the value
9950
+ # in the following format.
9530
9951
  #
9531
9952
  # `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
9532
9953
  #
@@ -10654,7 +11075,7 @@ module Aws::IoT
10654
11075
  # The output from the ListCACertificates operation.
10655
11076
  #
10656
11077
  # @!attribute [rw] certificates
10657
- # The CA certificates registered in your AWS account.
11078
+ # The CA certificates registered in your Amazon Web Services account.
10658
11079
  # @return [Array<Types::CACertificate>]
10659
11080
  #
10660
11081
  # @!attribute [rw] next_marker
@@ -11030,6 +11451,47 @@ module Aws::IoT
11030
11451
  include Aws::Structure
11031
11452
  end
11032
11453
 
11454
+ # @note When making an API call, you may pass ListFleetMetricsRequest
11455
+ # data as a hash:
11456
+ #
11457
+ # {
11458
+ # next_token: "NextToken",
11459
+ # max_results: 1,
11460
+ # }
11461
+ #
11462
+ # @!attribute [rw] next_token
11463
+ # To retrieve the next set of results, the `nextToken` value from a
11464
+ # previous response; otherwise `null` to receive the first set of
11465
+ # results.
11466
+ # @return [String]
11467
+ #
11468
+ # @!attribute [rw] max_results
11469
+ # The maximum number of results to return in this operation.
11470
+ # @return [Integer]
11471
+ #
11472
+ class ListFleetMetricsRequest < Struct.new(
11473
+ :next_token,
11474
+ :max_results)
11475
+ SENSITIVE = []
11476
+ include Aws::Structure
11477
+ end
11478
+
11479
+ # @!attribute [rw] fleet_metrics
11480
+ # The list of fleet metrics objects.
11481
+ # @return [Array<Types::FleetMetricNameAndArn>]
11482
+ #
11483
+ # @!attribute [rw] next_token
11484
+ # The token for the next set of results. Will not be returned if the
11485
+ # operation has returned all results.
11486
+ # @return [String]
11487
+ #
11488
+ class ListFleetMetricsResponse < Struct.new(
11489
+ :fleet_metrics,
11490
+ :next_token)
11491
+ SENSITIVE = []
11492
+ include Aws::Structure
11493
+ end
11494
+
11033
11495
  # @note When making an API call, you may pass ListIndicesRequest
11034
11496
  # data as a hash:
11035
11497
  #
@@ -11144,9 +11606,9 @@ module Aws::IoT
11144
11606
  # @!attribute [rw] namespace_id
11145
11607
  # The namespace used to indicate that a job is a customer-managed job.
11146
11608
  #
11147
- # When you specify a value for this parameter, AWS IoT Core sends jobs
11148
- # notifications to MQTT topics that contain the value in the following
11149
- # format.
11609
+ # When you specify a value for this parameter, Amazon Web Services IoT
11610
+ # Core sends jobs notifications to MQTT topics that contain the value
11611
+ # in the following format.
11150
11612
  #
11151
11613
  # `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
11152
11614
  #
@@ -11276,9 +11738,9 @@ module Aws::IoT
11276
11738
  # @!attribute [rw] namespace_id
11277
11739
  # The namespace used to indicate that a job is a customer-managed job.
11278
11740
  #
11279
- # When you specify a value for this parameter, AWS IoT Core sends jobs
11280
- # notifications to MQTT topics that contain the value in the following
11281
- # format.
11741
+ # When you specify a value for this parameter, Amazon Web Services IoT
11742
+ # Core sends jobs notifications to MQTT topics that contain the value
11743
+ # in the following format.
11282
11744
  #
11283
11745
  # `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
11284
11746
  #
@@ -13175,8 +13637,8 @@ module Aws::IoT
13175
13637
  # @return [Types::ReplaceDefaultPolicyVersionParams]
13176
13638
  #
13177
13639
  # @!attribute [rw] enable_io_t_logging_params
13178
- # Parameters to define a mitigation action that enables AWS IoT
13179
- # logging at a specified level of detail.
13640
+ # Parameters to define a mitigation action that enables Amazon Web
13641
+ # Services IoT Core logging at a specified level of detail.
13180
13642
  # @return [Types::EnableIoTLoggingParams]
13181
13643
  #
13182
13644
  # @!attribute [rw] publish_finding_to_sns_params
@@ -13411,11 +13873,11 @@ module Aws::IoT
13411
13873
  # @return [String]
13412
13874
  #
13413
13875
  # @!attribute [rw] aws_iot_job_id
13414
- # The AWS IoT job ID associated with the OTA update.
13876
+ # The IoT job ID associated with the OTA update.
13415
13877
  # @return [String]
13416
13878
  #
13417
13879
  # @!attribute [rw] aws_iot_job_arn
13418
- # The AWS IoT job ARN associated with the OTA update.
13880
+ # The IoT job ARN associated with the OTA update.
13419
13881
  # @return [String]
13420
13882
  #
13421
13883
  # @!attribute [rw] error_info
@@ -13469,6 +13931,50 @@ module Aws::IoT
13469
13931
  include Aws::Structure
13470
13932
  end
13471
13933
 
13934
+ # Describes an action that writes data to an Amazon OpenSearch Service
13935
+ # domain.
13936
+ #
13937
+ # @note When making an API call, you may pass OpenSearchAction
13938
+ # data as a hash:
13939
+ #
13940
+ # {
13941
+ # role_arn: "AwsArn", # required
13942
+ # endpoint: "ElasticsearchEndpoint", # required
13943
+ # index: "ElasticsearchIndex", # required
13944
+ # type: "ElasticsearchType", # required
13945
+ # id: "ElasticsearchId", # required
13946
+ # }
13947
+ #
13948
+ # @!attribute [rw] role_arn
13949
+ # The IAM role ARN that has access to OpenSearch.
13950
+ # @return [String]
13951
+ #
13952
+ # @!attribute [rw] endpoint
13953
+ # The endpoint of your OpenSearch domain.
13954
+ # @return [String]
13955
+ #
13956
+ # @!attribute [rw] index
13957
+ # The OpenSearch index where you want to store your data.
13958
+ # @return [String]
13959
+ #
13960
+ # @!attribute [rw] type
13961
+ # The type of document you are storing.
13962
+ # @return [String]
13963
+ #
13964
+ # @!attribute [rw] id
13965
+ # The unique identifier for the document you are storing.
13966
+ # @return [String]
13967
+ #
13968
+ class OpenSearchAction < Struct.new(
13969
+ :role_arn,
13970
+ :endpoint,
13971
+ :index,
13972
+ :type,
13973
+ :id)
13974
+ SENSITIVE = []
13975
+ include Aws::Structure
13976
+ end
13977
+
13472
13978
  # A certificate that has been transferred but not yet accepted.
13473
13979
  #
13474
13980
  # @!attribute [rw] certificate_arn
@@ -13480,7 +13986,7 @@ module Aws::IoT
13480
13986
  # @return [String]
13481
13987
  #
13482
13988
  # @!attribute [rw] transferred_to
13483
- # The AWS account to which the transfer was made.
13989
+ # The Amazon Web Services account to which the transfer was made.
13484
13990
  # @return [String]
13485
13991
  #
13486
13992
  # @!attribute [rw] transfer_date
@@ -13523,7 +14029,7 @@ module Aws::IoT
13523
14029
  include Aws::Structure
13524
14030
  end
13525
14031
 
13526
- # Describes an AWS IoT policy.
14032
+ # Describes an IoT policy.
13527
14033
  #
13528
14034
  # @!attribute [rw] policy_name
13529
14035
  # The policy name.
@@ -13762,7 +14268,7 @@ module Aws::IoT
13762
14268
  # @return [String]
13763
14269
  #
13764
14270
  # @!attribute [rw] asset_id
13765
- # The ID of the AWS IoT SiteWise asset. You must specify either a
14271
+ # The ID of the IoT SiteWise asset. You must specify either a
13766
14272
  # `propertyAlias` or both an `aliasId` and a `propertyId`. Accepts
13767
14273
  # substitution templates.
13768
14274
  # @return [String]
@@ -14431,6 +14937,13 @@ module Aws::IoT
14431
14937
  # "String" => "String",
14432
14938
  # },
14433
14939
  # },
14940
+ # open_search: {
14941
+ # role_arn: "AwsArn", # required
14942
+ # endpoint: "ElasticsearchEndpoint", # required
14943
+ # index: "ElasticsearchIndex", # required
14944
+ # type: "ElasticsearchType", # required
14945
+ # id: "ElasticsearchId", # required
14946
+ # },
14434
14947
  # },
14435
14948
  # ],
14436
14949
  # rule_disabled: false,
@@ -14602,6 +15115,13 @@ module Aws::IoT
14602
15115
  # "String" => "String",
14603
15116
  # },
14604
15117
  # },
15118
+ # open_search: {
15119
+ # role_arn: "AwsArn", # required
15120
+ # endpoint: "ElasticsearchEndpoint", # required
15121
+ # index: "ElasticsearchIndex", # required
15122
+ # type: "ElasticsearchType", # required
15123
+ # id: "ElasticsearchId", # required
15124
+ # },
14605
15125
  # },
14606
15126
  # },
14607
15127
  # }
@@ -15436,7 +15956,7 @@ module Aws::IoT
15436
15956
  #
15437
15957
  # @!attribute [rw] audit_check_to_actions_mapping
15438
15958
  # For an audit check, specifies which mitigation actions to apply.
15439
- # Those actions must be defined in your AWS account.
15959
+ # Those actions must be defined in your Amazon Web Services accounts.
15440
15960
  # @return [Hash<String,Array<String>>]
15441
15961
  #
15442
15962
  # @!attribute [rw] client_request_token
@@ -15518,8 +16038,9 @@ module Aws::IoT
15518
16038
  # @!attribute [rw] client_request_token
15519
16039
  # Each mitigation action task must have a unique client request token.
15520
16040
  # If you try to create a new task with the same token as a task that
15521
- # already exists, an exception occurs. If you omit this value, AWS
15522
- # SDKs will automatically generate a unique client request.
16041
+ # already exists, an exception occurs. If you omit this value, Amazon
16042
+ # Web Services SDKs will automatically generate a unique client
16043
+ # request.
15523
16044
  #
15524
16045
  # **A suitable default value is auto-generated.** You should normally
15525
16046
  # not need to pass this option.
@@ -15883,7 +16404,7 @@ module Aws::IoT
15883
16404
  # @return [Time]
15884
16405
  #
15885
16406
  # @!attribute [rw] role_arn
15886
- # An IAM role AWS IoT assumes to access your S3 files.
16407
+ # An IAM role IoT assumes to access your S3 files.
15887
16408
  # @return [String]
15888
16409
  #
15889
16410
  class StreamInfo < Struct.new(
@@ -16074,6 +16595,27 @@ module Aws::IoT
16074
16595
  include Aws::Structure
16075
16596
  end
16076
16597
 
16598
+ # Performs an aggregation that will return a list of buckets. The list
16599
+ # of buckets is a ranked list of the number of occurrences of an
16600
+ # aggregation field value.
16601
+ #
16602
+ # @note When making an API call, you may pass TermsAggregation
16603
+ # data as a hash:
16604
+ #
16605
+ # {
16606
+ # max_buckets: 1,
16607
+ # }
16608
+ #
16609
+ # @!attribute [rw] max_buckets
16610
+ # The number of buckets to return in the response. Default to 10.
16611
+ # @return [Integer]
16612
+ #
16613
+ class TermsAggregation < Struct.new(
16614
+ :max_buckets)
16615
+ SENSITIVE = []
16616
+ include Aws::Structure
16617
+ end
16618
+
16077
16619
  # @note When making an API call, you may pass TestAuthorizationRequest
16078
16620
  # data as a hash:
16079
16621
  #
@@ -16271,19 +16813,26 @@ module Aws::IoT
16271
16813
  # The connectivity status of the thing.
16272
16814
  #
16273
16815
  # @!attribute [rw] connected
16274
- # True if the thing is connected to the AWS IoT service; false if it
16275
- # is not connected.
16816
+ # True if the thing is connected to the Amazon Web Services IoT Core
16817
+ # service; false if it is not connected.
16276
16818
  # @return [Boolean]
16277
16819
  #
16278
16820
  # @!attribute [rw] timestamp
16279
16821
  # The epoch time (in milliseconds) when the thing last connected or
16280
- # disconnected. If the thing has been disconnected for more than a few
16281
- # weeks, the time value might be missing.
16822
+ # disconnected. If the thing has been disconnected for approximately
16823
+ # an hour, the time value might be missing.
16282
16824
  # @return [Integer]
16283
16825
  #
16826
+ # @!attribute [rw] disconnect_reason
16827
+ # The reason why the client is disconnected. If the thing has been
16828
+ # disconnected for approximately an hour, the `disconnectReason` value
16829
+ # might be missing.
16830
+ # @return [String]
16831
+ #
16284
16832
  class ThingConnectivity < Struct.new(
16285
16833
  :connected,
16286
- :timestamp)
16834
+ :timestamp,
16835
+ :disconnect_reason)
16287
16836
  SENSITIVE = []
16288
16837
  include Aws::Structure
16289
16838
  end
@@ -16315,7 +16864,8 @@ module Aws::IoT
16315
16864
  # @return [String]
16316
16865
  #
16317
16866
  # @!attribute [rw] connectivity
16318
- # Indicates whether the thing is connected to the AWS IoT service.
16867
+ # Indicates whether the thing is connected to the Amazon Web Services
16868
+ # IoT Core service.
16319
16869
  # @return [Types::ThingConnectivity]
16320
16870
  #
16321
16871
  class ThingDocument < Struct.new(
@@ -16502,7 +17052,7 @@ module Aws::IoT
16502
17052
  # Thing connectivity indexing mode. Valid values are:
16503
17053
  #
16504
17054
  # * STATUS – Your thing index contains connectivity status. To enable
16505
- # thing connectivity indexing, thingIndexMode must not be set to
17055
+ # thing connectivity indexing, *thingIndexMode* must not be set to
16506
17056
  # OFF.
16507
17057
  #
16508
17058
  # * OFF - Thing connectivity status indexing is disabled.
@@ -17231,6 +17781,13 @@ module Aws::IoT
17231
17781
  # "String" => "String",
17232
17782
  # },
17233
17783
  # },
17784
+ # open_search: {
17785
+ # role_arn: "AwsArn", # required
17786
+ # endpoint: "ElasticsearchEndpoint", # required
17787
+ # index: "ElasticsearchIndex", # required
17788
+ # type: "ElasticsearchType", # required
17789
+ # id: "ElasticsearchId", # required
17790
+ # },
17234
17791
  # },
17235
17792
  # ],
17236
17793
  # rule_disabled: false,
@@ -17402,12 +17959,19 @@ module Aws::IoT
17402
17959
  # "String" => "String",
17403
17960
  # },
17404
17961
  # },
17962
+ # open_search: {
17963
+ # role_arn: "AwsArn", # required
17964
+ # endpoint: "ElasticsearchEndpoint", # required
17965
+ # index: "ElasticsearchIndex", # required
17966
+ # type: "ElasticsearchType", # required
17967
+ # id: "ElasticsearchId", # required
17968
+ # },
17405
17969
  # },
17406
17970
  # }
17407
17971
  #
17408
17972
  # @!attribute [rw] sql
17409
17973
  # The SQL statement used to query the topic. For more information, see
17410
- # [AWS IoT SQL Reference][1] in the *AWS IoT Developer Guide*.
17974
+ # [IoT SQL Reference][1] in the *IoT Developer Guide*.
17411
17975
  #
17412
17976
  #
17413
17977
  #
@@ -17475,7 +18039,7 @@ module Aws::IoT
17475
18039
  # @return [String]
17476
18040
  #
17477
18041
  # @!attribute [rw] target_aws_account
17478
- # The AWS account.
18042
+ # The Amazon Web Services account.
17479
18043
  # @return [String]
17480
18044
  #
17481
18045
  # @!attribute [rw] transfer_message
@@ -17515,7 +18079,7 @@ module Aws::IoT
17515
18079
  include Aws::Structure
17516
18080
  end
17517
18081
 
17518
- # Data used to transfer a certificate to an AWS account.
18082
+ # Data used to transfer a certificate to an Amazon Web Services account.
17519
18083
  #
17520
18084
  # @!attribute [rw] transfer_message
17521
18085
  # The transfer message.
@@ -17605,7 +18169,7 @@ module Aws::IoT
17605
18169
  #
17606
18170
  # @!attribute [rw] role_arn
17607
18171
  # The Amazon Resource Name (ARN) of the role that grants permission to
17608
- # AWS IoT to access information about your devices, policies,
18172
+ # IoT to access information about your devices, policies,
17609
18173
  # certificates, and other items as required when performing an audit.
17610
18174
  # @return [String]
17611
18175
  #
@@ -17894,7 +18458,7 @@ module Aws::IoT
17894
18458
  # **Note:** Setting the status to PENDING\_TRANSFER or
17895
18459
  # PENDING\_ACTIVATION will result in an exception being thrown.
17896
18460
  # PENDING\_TRANSFER and PENDING\_ACTIVATION are statuses used
17897
- # internally by AWS IoT. They are not intended for developer use.
18461
+ # internally by IoT. They are not intended for developer use.
17898
18462
  #
17899
18463
  # **Note:** The status value REGISTER\_INACTIVE is deprecated and
17900
18464
  # should not be used.
@@ -18144,7 +18708,7 @@ module Aws::IoT
18144
18708
  # @!attribute [rw] index_name
18145
18709
  # The dynamic thing group index to update.
18146
18710
  #
18147
- # <note markdown="1"> Currently one index is supported: 'AWS\_Things'.
18711
+ # <note markdown="1"> Currently one index is supported: `AWS_Things`.
18148
18712
  #
18149
18713
  # </note>
18150
18714
  # @return [String]
@@ -18206,6 +18770,86 @@ module Aws::IoT
18206
18770
 
18207
18771
  class UpdateEventConfigurationsResponse < Aws::EmptyStructure; end
18208
18772
 
18773
+ # @note When making an API call, you may pass UpdateFleetMetricRequest
18774
+ # data as a hash:
18775
+ #
18776
+ # {
18777
+ # metric_name: "FleetMetricName", # required
18778
+ # query_string: "QueryString",
18779
+ # aggregation_type: {
18780
+ # name: "Statistics", # required, accepts Statistics, Percentiles, Cardinality
18781
+ # values: ["AggregationTypeValue"],
18782
+ # },
18783
+ # period: 1,
18784
+ # aggregation_field: "AggregationField",
18785
+ # description: "FleetMetricDescription",
18786
+ # query_version: "QueryVersion",
18787
+ # index_name: "IndexName", # required
18788
+ # unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
18789
+ # expected_version: 1,
18790
+ # }
18791
+ #
18792
+ # @!attribute [rw] metric_name
18793
+ # The name of the fleet metric to update.
18794
+ # @return [String]
18795
+ #
18796
+ # @!attribute [rw] query_string
18797
+ # The search query string.
18798
+ # @return [String]
18799
+ #
18800
+ # @!attribute [rw] aggregation_type
18801
+ # The type of the aggregation query.
18802
+ # @return [Types::AggregationType]
18803
+ #
18804
+ # @!attribute [rw] period
18805
+ # The time in seconds between fleet metric emissions. Range \[60(1
18806
+ # min), 86400(1 day)\] and must be multiple of 60.
18807
+ # @return [Integer]
18808
+ #
18809
+ # @!attribute [rw] aggregation_field
18810
+ # The field to aggregate.
18811
+ # @return [String]
18812
+ #
18813
+ # @!attribute [rw] description
18814
+ # The description of the fleet metric.
18815
+ # @return [String]
18816
+ #
18817
+ # @!attribute [rw] query_version
18818
+ # The version of the query.
18819
+ # @return [String]
18820
+ #
18821
+ # @!attribute [rw] index_name
18822
+ # The name of the index to search.
18823
+ # @return [String]
18824
+ #
18825
+ # @!attribute [rw] unit
18826
+ # Used to support unit transformation such as milliseconds to seconds.
18827
+ # The unit must be supported by [CW metric][1].
18828
+ #
18829
+ #
18830
+ #
18831
+ # [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
18832
+ # @return [String]
18833
+ #
18834
+ # @!attribute [rw] expected_version
18835
+ # The expected version of the fleet metric record in the registry.
18836
+ # @return [Integer]
18837
+ #
18838
+ class UpdateFleetMetricRequest < Struct.new(
18839
+ :metric_name,
18840
+ :query_string,
18841
+ :aggregation_type,
18842
+ :period,
18843
+ :aggregation_field,
18844
+ :description,
18845
+ :query_version,
18846
+ :index_name,
18847
+ :unit,
18848
+ :expected_version)
18849
+ SENSITIVE = []
18850
+ include Aws::Structure
18851
+ end
18852
+
18209
18853
  # @note When making an API call, you may pass UpdateIndexingConfigurationRequest
18210
18854
  # data as a hash:
18211
18855
  #
@@ -18328,9 +18972,9 @@ module Aws::IoT
18328
18972
  # @!attribute [rw] namespace_id
18329
18973
  # The namespace used to indicate that a job is a customer-managed job.
18330
18974
  #
18331
- # When you specify a value for this parameter, AWS IoT Core sends jobs
18332
- # notifications to MQTT topics that contain the value in the following
18333
- # format.
18975
+ # When you specify a value for this parameter, Amazon Web Services IoT
18976
+ # Core sends jobs notifications to MQTT topics that contain the value
18977
+ # in the following format.
18334
18978
  #
18335
18979
  # `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
18336
18980
  #