aws-sdk-iotdataplane 1.30.0 → 1.34.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotdataplane/client.rb +168 -14
- data/lib/aws-sdk-iotdataplane/client_api.rb +70 -0
- data/lib/aws-sdk-iotdataplane/types.rb +142 -4
- data/lib/aws-sdk-iotdataplane.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4953278cee2906b43f7e57058b9bfc3b414498f986cb87d5dbfb66054042c36e
|
4
|
+
data.tar.gz: 5f3ccc0ac800740ee7189caa65cd0ff951d030d75461cb7103c1e1d1e9c4cac7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 26807c714c6fc8ef23b35ae4ed1ddf5bc8c12266d6c6e7b74db35e7d6217414fb711a7824201329e88d564fa3f6538f0e340ad18a823de5a410e5b54547bd8e9
|
7
|
+
data.tar.gz: 5928285b61d671262c5eda551d83a51bd141316dcd310706a624f3f40c38d7ef51e267d47cc96c1a2f98e690e06b4ea3c780f8385688aa0aff2689ad571cd674
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.34.0 (2021-11-04)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.33.0 (2021-10-18)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.32.0 (2021-09-01)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.31.0 (2021-08-24)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Updated Publish with support for new Retain flag and added two new API operations: GetRetainedMessage, ListRetainedMessages.
|
23
|
+
|
4
24
|
1.30.0 (2021-07-30)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.34.0
|
@@ -275,6 +275,15 @@ module Aws::IoTDataPlane
|
|
275
275
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
276
|
# requests are made, and retries are disabled.
|
277
277
|
#
|
278
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
279
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
280
|
+
# will be used if available.
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :use_fips_endpoint
|
283
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
284
|
+
# When a `fips` region is used, the region is normalized and this config
|
285
|
+
# is set to `true`.
|
286
|
+
#
|
278
287
|
# @option options [Boolean] :validate_params (true)
|
279
288
|
# When `true`, request parameters are validated before
|
280
289
|
# sending the request.
|
@@ -329,12 +338,15 @@ module Aws::IoTDataPlane
|
|
329
338
|
|
330
339
|
# Deletes the shadow for the specified thing.
|
331
340
|
#
|
332
|
-
#
|
333
|
-
#
|
341
|
+
# Requires permission to access the [DeleteThingShadow][1] action.
|
342
|
+
#
|
343
|
+
# For more information, see [DeleteThingShadow][2] in the IoT Developer
|
344
|
+
# Guide.
|
334
345
|
#
|
335
346
|
#
|
336
347
|
#
|
337
|
-
# [1]:
|
348
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
349
|
+
# [2]: http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html
|
338
350
|
#
|
339
351
|
# @option params [required, String] :thing_name
|
340
352
|
# The name of the thing.
|
@@ -364,14 +376,64 @@ module Aws::IoTDataPlane
|
|
364
376
|
req.send_request(options)
|
365
377
|
end
|
366
378
|
|
379
|
+
# Gets the details of a single retained message for the specified topic.
|
380
|
+
#
|
381
|
+
# This action returns the message payload of the retained message, which
|
382
|
+
# can incur messaging costs. To list only the topic names of the
|
383
|
+
# retained messages, call
|
384
|
+
# [ListRetainedMessages](/iot/latest/developerguide/API_iotdata_ListRetainedMessages.html).
|
385
|
+
#
|
386
|
+
# Requires permission to access the [GetRetainedMessage][1] action.
|
387
|
+
#
|
388
|
+
# For more information about messaging costs, see [IoT Core pricing -
|
389
|
+
# Messaging][2].
|
390
|
+
#
|
391
|
+
#
|
392
|
+
#
|
393
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions
|
394
|
+
# [2]: http://aws.amazon.com/iot-core/pricing/#Messaging
|
395
|
+
#
|
396
|
+
# @option params [required, String] :topic
|
397
|
+
# The topic name of the retained message to retrieve.
|
398
|
+
#
|
399
|
+
# @return [Types::GetRetainedMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
400
|
+
#
|
401
|
+
# * {Types::GetRetainedMessageResponse#topic #topic} => String
|
402
|
+
# * {Types::GetRetainedMessageResponse#payload #payload} => String
|
403
|
+
# * {Types::GetRetainedMessageResponse#qos #qos} => Integer
|
404
|
+
# * {Types::GetRetainedMessageResponse#last_modified_time #last_modified_time} => Integer
|
405
|
+
#
|
406
|
+
# @example Request syntax with placeholder values
|
407
|
+
#
|
408
|
+
# resp = client.get_retained_message({
|
409
|
+
# topic: "Topic", # required
|
410
|
+
# })
|
411
|
+
#
|
412
|
+
# @example Response structure
|
413
|
+
#
|
414
|
+
# resp.topic #=> String
|
415
|
+
# resp.payload #=> String
|
416
|
+
# resp.qos #=> Integer
|
417
|
+
# resp.last_modified_time #=> Integer
|
418
|
+
#
|
419
|
+
# @overload get_retained_message(params = {})
|
420
|
+
# @param [Hash] params ({})
|
421
|
+
def get_retained_message(params = {}, options = {})
|
422
|
+
req = build_request(:get_retained_message, params)
|
423
|
+
req.send_request(options)
|
424
|
+
end
|
425
|
+
|
367
426
|
# Gets the shadow for the specified thing.
|
368
427
|
#
|
369
|
-
#
|
428
|
+
# Requires permission to access the [GetThingShadow][1] action.
|
429
|
+
#
|
430
|
+
# For more information, see [GetThingShadow][2] in the IoT Developer
|
370
431
|
# Guide.
|
371
432
|
#
|
372
433
|
#
|
373
434
|
#
|
374
|
-
# [1]:
|
435
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
436
|
+
# [2]: http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html
|
375
437
|
#
|
376
438
|
# @option params [required, String] :thing_name
|
377
439
|
# The name of the thing.
|
@@ -403,6 +465,13 @@ module Aws::IoTDataPlane
|
|
403
465
|
|
404
466
|
# Lists the shadows for the specified thing.
|
405
467
|
#
|
468
|
+
# Requires permission to access the [ListNamedShadowsForThing][1]
|
469
|
+
# action.
|
470
|
+
#
|
471
|
+
#
|
472
|
+
#
|
473
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
474
|
+
#
|
406
475
|
# @option params [required, String] :thing_name
|
407
476
|
# The name of the thing.
|
408
477
|
#
|
@@ -440,14 +509,80 @@ module Aws::IoTDataPlane
|
|
440
509
|
req.send_request(options)
|
441
510
|
end
|
442
511
|
|
443
|
-
#
|
512
|
+
# Lists summary information about the retained messages stored for the
|
513
|
+
# account.
|
444
514
|
#
|
445
|
-
#
|
446
|
-
#
|
515
|
+
# This action returns only the topic names of the retained messages. It
|
516
|
+
# doesn't return any message payloads. Although this action doesn't
|
517
|
+
# return a message payload, it can still incur messaging costs.
|
518
|
+
#
|
519
|
+
# To get the message payload of a retained message, call
|
520
|
+
# [GetRetainedMessage][1] with the topic name of the retained message.
|
447
521
|
#
|
522
|
+
# Requires permission to access the [ListRetainedMessages][2] action.
|
448
523
|
#
|
524
|
+
# For more information about messaging costs, see [IoT Core pricing -
|
525
|
+
# Messaging][3].
|
449
526
|
#
|
450
|
-
#
|
527
|
+
#
|
528
|
+
#
|
529
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/API_iotdata_GetRetainedMessage.html
|
530
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions
|
531
|
+
# [3]: http://aws.amazon.com/iot-core/pricing/#Messaging
|
532
|
+
#
|
533
|
+
# @option params [String] :next_token
|
534
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
535
|
+
# previous response; otherwise **null** to receive the first set of
|
536
|
+
# results.
|
537
|
+
#
|
538
|
+
# @option params [Integer] :max_results
|
539
|
+
# The maximum number of results to return at one time.
|
540
|
+
#
|
541
|
+
# @return [Types::ListRetainedMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
542
|
+
#
|
543
|
+
# * {Types::ListRetainedMessagesResponse#retained_topics #retained_topics} => Array<Types::RetainedMessageSummary>
|
544
|
+
# * {Types::ListRetainedMessagesResponse#next_token #next_token} => String
|
545
|
+
#
|
546
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
547
|
+
#
|
548
|
+
# @example Request syntax with placeholder values
|
549
|
+
#
|
550
|
+
# resp = client.list_retained_messages({
|
551
|
+
# next_token: "NextToken",
|
552
|
+
# max_results: 1,
|
553
|
+
# })
|
554
|
+
#
|
555
|
+
# @example Response structure
|
556
|
+
#
|
557
|
+
# resp.retained_topics #=> Array
|
558
|
+
# resp.retained_topics[0].topic #=> String
|
559
|
+
# resp.retained_topics[0].payload_size #=> Integer
|
560
|
+
# resp.retained_topics[0].qos #=> Integer
|
561
|
+
# resp.retained_topics[0].last_modified_time #=> Integer
|
562
|
+
# resp.next_token #=> String
|
563
|
+
#
|
564
|
+
# @overload list_retained_messages(params = {})
|
565
|
+
# @param [Hash] params ({})
|
566
|
+
def list_retained_messages(params = {}, options = {})
|
567
|
+
req = build_request(:list_retained_messages, params)
|
568
|
+
req.send_request(options)
|
569
|
+
end
|
570
|
+
|
571
|
+
# Publishes an MQTT message.
|
572
|
+
#
|
573
|
+
# Requires permission to access the [Publish][1] action.
|
574
|
+
#
|
575
|
+
# For more information about MQTT messages, see [MQTT Protocol][2] in
|
576
|
+
# the IoT Developer Guide.
|
577
|
+
#
|
578
|
+
# For more information about messaging costs, see [IoT Core pricing -
|
579
|
+
# Messaging][3].
|
580
|
+
#
|
581
|
+
#
|
582
|
+
#
|
583
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
584
|
+
# [2]: http://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html
|
585
|
+
# [3]: http://aws.amazon.com/iot-core/pricing/#Messaging
|
451
586
|
#
|
452
587
|
# @option params [required, String] :topic
|
453
588
|
# The name of the MQTT topic.
|
@@ -455,8 +590,23 @@ module Aws::IoTDataPlane
|
|
455
590
|
# @option params [Integer] :qos
|
456
591
|
# The Quality of Service (QoS) level.
|
457
592
|
#
|
593
|
+
# @option params [Boolean] :retain
|
594
|
+
# A Boolean value that determines whether to set the RETAIN flag when
|
595
|
+
# the message is published.
|
596
|
+
#
|
597
|
+
# Setting the RETAIN flag causes the message to be retained and sent to
|
598
|
+
# new subscribers to the topic.
|
599
|
+
#
|
600
|
+
# Valid values: `true` \| `false`
|
601
|
+
#
|
602
|
+
# Default value: `false`
|
603
|
+
#
|
458
604
|
# @option params [String, StringIO, File] :payload
|
459
|
-
# The
|
605
|
+
# The message body. MQTT accepts text, binary, and empty (null) message
|
606
|
+
# payloads.
|
607
|
+
#
|
608
|
+
# Publishing an empty (null) payload with **retain** = `true` deletes
|
609
|
+
# the retained message identified by **topic** from IoT Core.
|
460
610
|
#
|
461
611
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
462
612
|
#
|
@@ -465,6 +615,7 @@ module Aws::IoTDataPlane
|
|
465
615
|
# resp = client.publish({
|
466
616
|
# topic: "Topic", # required
|
467
617
|
# qos: 1,
|
618
|
+
# retain: false,
|
468
619
|
# payload: "data",
|
469
620
|
# })
|
470
621
|
#
|
@@ -477,12 +628,15 @@ module Aws::IoTDataPlane
|
|
477
628
|
|
478
629
|
# Updates the shadow for the specified thing.
|
479
630
|
#
|
480
|
-
#
|
481
|
-
#
|
631
|
+
# Requires permission to access the [UpdateThingShadow][1] action.
|
632
|
+
#
|
633
|
+
# For more information, see [UpdateThingShadow][2] in the IoT Developer
|
634
|
+
# Guide.
|
482
635
|
#
|
483
636
|
#
|
484
637
|
#
|
485
|
-
# [1]:
|
638
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
639
|
+
# [2]: http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html
|
486
640
|
#
|
487
641
|
# @option params [required, String] :thing_name
|
488
642
|
# The name of the thing.
|
@@ -529,7 +683,7 @@ module Aws::IoTDataPlane
|
|
529
683
|
params: params,
|
530
684
|
config: config)
|
531
685
|
context[:gem_name] = 'aws-sdk-iotdataplane'
|
532
|
-
context[:gem_version] = '1.
|
686
|
+
context[:gem_version] = '1.34.0'
|
533
687
|
Seahorse::Client::Request.new(handlers, context)
|
534
688
|
end
|
535
689
|
|
@@ -16,6 +16,8 @@ module Aws::IoTDataPlane
|
|
16
16
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
17
17
|
DeleteThingShadowRequest = Shapes::StructureShape.new(name: 'DeleteThingShadowRequest')
|
18
18
|
DeleteThingShadowResponse = Shapes::StructureShape.new(name: 'DeleteThingShadowResponse')
|
19
|
+
GetRetainedMessageRequest = Shapes::StructureShape.new(name: 'GetRetainedMessageRequest')
|
20
|
+
GetRetainedMessageResponse = Shapes::StructureShape.new(name: 'GetRetainedMessageResponse')
|
19
21
|
GetThingShadowRequest = Shapes::StructureShape.new(name: 'GetThingShadowRequest')
|
20
22
|
GetThingShadowResponse = Shapes::StructureShape.new(name: 'GetThingShadowResponse')
|
21
23
|
InternalFailureException = Shapes::StructureShape.new(name: 'InternalFailureException')
|
@@ -23,15 +25,22 @@ module Aws::IoTDataPlane
|
|
23
25
|
JsonDocument = Shapes::BlobShape.new(name: 'JsonDocument')
|
24
26
|
ListNamedShadowsForThingRequest = Shapes::StructureShape.new(name: 'ListNamedShadowsForThingRequest')
|
25
27
|
ListNamedShadowsForThingResponse = Shapes::StructureShape.new(name: 'ListNamedShadowsForThingResponse')
|
28
|
+
ListRetainedMessagesRequest = Shapes::StructureShape.new(name: 'ListRetainedMessagesRequest')
|
29
|
+
ListRetainedMessagesResponse = Shapes::StructureShape.new(name: 'ListRetainedMessagesResponse')
|
30
|
+
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
26
31
|
MethodNotAllowedException = Shapes::StructureShape.new(name: 'MethodNotAllowedException')
|
27
32
|
NamedShadowList = Shapes::ListShape.new(name: 'NamedShadowList')
|
28
33
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
29
34
|
PageSize = Shapes::IntegerShape.new(name: 'PageSize')
|
30
35
|
Payload = Shapes::BlobShape.new(name: 'Payload')
|
36
|
+
PayloadSize = Shapes::IntegerShape.new(name: 'PayloadSize')
|
31
37
|
PublishRequest = Shapes::StructureShape.new(name: 'PublishRequest')
|
32
38
|
Qos = Shapes::IntegerShape.new(name: 'Qos')
|
33
39
|
RequestEntityTooLargeException = Shapes::StructureShape.new(name: 'RequestEntityTooLargeException')
|
34
40
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
41
|
+
Retain = Shapes::BooleanShape.new(name: 'Retain')
|
42
|
+
RetainedMessageList = Shapes::ListShape.new(name: 'RetainedMessageList')
|
43
|
+
RetainedMessageSummary = Shapes::StructureShape.new(name: 'RetainedMessageSummary')
|
35
44
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
36
45
|
ShadowName = Shapes::StringShape.new(name: 'ShadowName')
|
37
46
|
ThingName = Shapes::StringShape.new(name: 'ThingName')
|
@@ -56,6 +65,15 @@ module Aws::IoTDataPlane
|
|
56
65
|
DeleteThingShadowResponse[:payload] = :payload
|
57
66
|
DeleteThingShadowResponse[:payload_member] = DeleteThingShadowResponse.member(:payload)
|
58
67
|
|
68
|
+
GetRetainedMessageRequest.add_member(:topic, Shapes::ShapeRef.new(shape: Topic, required: true, location: "uri", location_name: "topic"))
|
69
|
+
GetRetainedMessageRequest.struct_class = Types::GetRetainedMessageRequest
|
70
|
+
|
71
|
+
GetRetainedMessageResponse.add_member(:topic, Shapes::ShapeRef.new(shape: Topic, location_name: "topic"))
|
72
|
+
GetRetainedMessageResponse.add_member(:payload, Shapes::ShapeRef.new(shape: Payload, location_name: "payload"))
|
73
|
+
GetRetainedMessageResponse.add_member(:qos, Shapes::ShapeRef.new(shape: Qos, location_name: "qos"))
|
74
|
+
GetRetainedMessageResponse.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastModifiedTime"))
|
75
|
+
GetRetainedMessageResponse.struct_class = Types::GetRetainedMessageResponse
|
76
|
+
|
59
77
|
GetThingShadowRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
|
60
78
|
GetThingShadowRequest.add_member(:shadow_name, Shapes::ShapeRef.new(shape: ShadowName, location: "querystring", location_name: "name"))
|
61
79
|
GetThingShadowRequest.struct_class = Types::GetThingShadowRequest
|
@@ -81,6 +99,14 @@ module Aws::IoTDataPlane
|
|
81
99
|
ListNamedShadowsForThingResponse.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "timestamp"))
|
82
100
|
ListNamedShadowsForThingResponse.struct_class = Types::ListNamedShadowsForThingResponse
|
83
101
|
|
102
|
+
ListRetainedMessagesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
103
|
+
ListRetainedMessagesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
104
|
+
ListRetainedMessagesRequest.struct_class = Types::ListRetainedMessagesRequest
|
105
|
+
|
106
|
+
ListRetainedMessagesResponse.add_member(:retained_topics, Shapes::ShapeRef.new(shape: RetainedMessageList, location_name: "retainedTopics"))
|
107
|
+
ListRetainedMessagesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
108
|
+
ListRetainedMessagesResponse.struct_class = Types::ListRetainedMessagesResponse
|
109
|
+
|
84
110
|
MethodNotAllowedException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
|
85
111
|
MethodNotAllowedException.struct_class = Types::MethodNotAllowedException
|
86
112
|
|
@@ -88,6 +114,7 @@ module Aws::IoTDataPlane
|
|
88
114
|
|
89
115
|
PublishRequest.add_member(:topic, Shapes::ShapeRef.new(shape: Topic, required: true, location: "uri", location_name: "topic"))
|
90
116
|
PublishRequest.add_member(:qos, Shapes::ShapeRef.new(shape: Qos, location: "querystring", location_name: "qos"))
|
117
|
+
PublishRequest.add_member(:retain, Shapes::ShapeRef.new(shape: Retain, location: "querystring", location_name: "retain"))
|
91
118
|
PublishRequest.add_member(:payload, Shapes::ShapeRef.new(shape: Payload, location_name: "payload"))
|
92
119
|
PublishRequest.struct_class = Types::PublishRequest
|
93
120
|
PublishRequest[:payload] = :payload
|
@@ -99,6 +126,14 @@ module Aws::IoTDataPlane
|
|
99
126
|
ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
|
100
127
|
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
101
128
|
|
129
|
+
RetainedMessageList.member = Shapes::ShapeRef.new(shape: RetainedMessageSummary)
|
130
|
+
|
131
|
+
RetainedMessageSummary.add_member(:topic, Shapes::ShapeRef.new(shape: Topic, location_name: "topic"))
|
132
|
+
RetainedMessageSummary.add_member(:payload_size, Shapes::ShapeRef.new(shape: PayloadSize, location_name: "payloadSize"))
|
133
|
+
RetainedMessageSummary.add_member(:qos, Shapes::ShapeRef.new(shape: Qos, location_name: "qos"))
|
134
|
+
RetainedMessageSummary.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastModifiedTime"))
|
135
|
+
RetainedMessageSummary.struct_class = Types::RetainedMessageSummary
|
136
|
+
|
102
137
|
ServiceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
|
103
138
|
ServiceUnavailableException.struct_class = Types::ServiceUnavailableException
|
104
139
|
|
@@ -155,6 +190,21 @@ module Aws::IoTDataPlane
|
|
155
190
|
o.errors << Shapes::ShapeRef.new(shape: UnsupportedDocumentEncodingException)
|
156
191
|
end)
|
157
192
|
|
193
|
+
api.add_operation(:get_retained_message, Seahorse::Model::Operation.new.tap do |o|
|
194
|
+
o.name = "GetRetainedMessage"
|
195
|
+
o.http_method = "GET"
|
196
|
+
o.http_request_uri = "/retainedMessage/{topic}"
|
197
|
+
o.input = Shapes::ShapeRef.new(shape: GetRetainedMessageRequest)
|
198
|
+
o.output = Shapes::ShapeRef.new(shape: GetRetainedMessageResponse)
|
199
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
200
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
201
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
202
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
203
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
204
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
205
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
206
|
+
end)
|
207
|
+
|
158
208
|
api.add_operation(:get_thing_shadow, Seahorse::Model::Operation.new.tap do |o|
|
159
209
|
o.name = "GetThingShadow"
|
160
210
|
o.http_method = "GET"
|
@@ -186,6 +236,26 @@ module Aws::IoTDataPlane
|
|
186
236
|
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
187
237
|
end)
|
188
238
|
|
239
|
+
api.add_operation(:list_retained_messages, Seahorse::Model::Operation.new.tap do |o|
|
240
|
+
o.name = "ListRetainedMessages"
|
241
|
+
o.http_method = "GET"
|
242
|
+
o.http_request_uri = "/retainedMessage"
|
243
|
+
o.input = Shapes::ShapeRef.new(shape: ListRetainedMessagesRequest)
|
244
|
+
o.output = Shapes::ShapeRef.new(shape: ListRetainedMessagesResponse)
|
245
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
246
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
247
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
248
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
249
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
250
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
251
|
+
o[:pager] = Aws::Pager.new(
|
252
|
+
limit_key: "max_results",
|
253
|
+
tokens: {
|
254
|
+
"next_token" => "next_token"
|
255
|
+
}
|
256
|
+
)
|
257
|
+
end)
|
258
|
+
|
189
259
|
api.add_operation(:publish, Seahorse::Model::Operation.new.tap do |o|
|
190
260
|
o.name = "Publish"
|
191
261
|
o.http_method = "POST"
|
@@ -59,6 +59,54 @@ module Aws::IoTDataPlane
|
|
59
59
|
include Aws::Structure
|
60
60
|
end
|
61
61
|
|
62
|
+
# The input for the GetRetainedMessage operation.
|
63
|
+
#
|
64
|
+
# @note When making an API call, you may pass GetRetainedMessageRequest
|
65
|
+
# data as a hash:
|
66
|
+
#
|
67
|
+
# {
|
68
|
+
# topic: "Topic", # required
|
69
|
+
# }
|
70
|
+
#
|
71
|
+
# @!attribute [rw] topic
|
72
|
+
# The topic name of the retained message to retrieve.
|
73
|
+
# @return [String]
|
74
|
+
#
|
75
|
+
class GetRetainedMessageRequest < Struct.new(
|
76
|
+
:topic)
|
77
|
+
SENSITIVE = []
|
78
|
+
include Aws::Structure
|
79
|
+
end
|
80
|
+
|
81
|
+
# The output from the GetRetainedMessage operation.
|
82
|
+
#
|
83
|
+
# @!attribute [rw] topic
|
84
|
+
# The topic name to which the retained message was published.
|
85
|
+
# @return [String]
|
86
|
+
#
|
87
|
+
# @!attribute [rw] payload
|
88
|
+
# The Base64-encoded message payload of the retained message body.
|
89
|
+
# @return [String]
|
90
|
+
#
|
91
|
+
# @!attribute [rw] qos
|
92
|
+
# The quality of service (QoS) level used to publish the retained
|
93
|
+
# message.
|
94
|
+
# @return [Integer]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] last_modified_time
|
97
|
+
# The Epoch date and time, in milliseconds, when the retained message
|
98
|
+
# was stored by IoT.
|
99
|
+
# @return [Integer]
|
100
|
+
#
|
101
|
+
class GetRetainedMessageResponse < Struct.new(
|
102
|
+
:topic,
|
103
|
+
:payload,
|
104
|
+
:qos,
|
105
|
+
:last_modified_time)
|
106
|
+
SENSITIVE = []
|
107
|
+
include Aws::Structure
|
108
|
+
end
|
109
|
+
|
62
110
|
# The input for the GetThingShadow operation.
|
63
111
|
#
|
64
112
|
# @note When making an API call, you may pass GetThingShadowRequest
|
@@ -154,12 +202,12 @@ module Aws::IoTDataPlane
|
|
154
202
|
# @return [Array<String>]
|
155
203
|
#
|
156
204
|
# @!attribute [rw] next_token
|
157
|
-
# The token
|
158
|
-
# additional results.
|
205
|
+
# The token to use to get the next set of results, or **null** if
|
206
|
+
# there are no additional results.
|
159
207
|
# @return [String]
|
160
208
|
#
|
161
209
|
# @!attribute [rw] timestamp
|
162
|
-
# The Epoch date and time the response was generated by
|
210
|
+
# The Epoch date and time the response was generated by IoT.
|
163
211
|
# @return [Integer]
|
164
212
|
#
|
165
213
|
class ListNamedShadowsForThingResponse < Struct.new(
|
@@ -170,6 +218,49 @@ module Aws::IoTDataPlane
|
|
170
218
|
include Aws::Structure
|
171
219
|
end
|
172
220
|
|
221
|
+
# @note When making an API call, you may pass ListRetainedMessagesRequest
|
222
|
+
# data as a hash:
|
223
|
+
#
|
224
|
+
# {
|
225
|
+
# next_token: "NextToken",
|
226
|
+
# max_results: 1,
|
227
|
+
# }
|
228
|
+
#
|
229
|
+
# @!attribute [rw] next_token
|
230
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
231
|
+
# previous response; otherwise **null** to receive the first set of
|
232
|
+
# results.
|
233
|
+
# @return [String]
|
234
|
+
#
|
235
|
+
# @!attribute [rw] max_results
|
236
|
+
# The maximum number of results to return at one time.
|
237
|
+
# @return [Integer]
|
238
|
+
#
|
239
|
+
class ListRetainedMessagesRequest < Struct.new(
|
240
|
+
:next_token,
|
241
|
+
:max_results)
|
242
|
+
SENSITIVE = []
|
243
|
+
include Aws::Structure
|
244
|
+
end
|
245
|
+
|
246
|
+
# @!attribute [rw] retained_topics
|
247
|
+
# A summary list the account's retained messages. The information
|
248
|
+
# returned doesn't include the message payloads of the retained
|
249
|
+
# messages.
|
250
|
+
# @return [Array<Types::RetainedMessageSummary>]
|
251
|
+
#
|
252
|
+
# @!attribute [rw] next_token
|
253
|
+
# The token for the next set of results, or null if there are no
|
254
|
+
# additional results.
|
255
|
+
# @return [String]
|
256
|
+
#
|
257
|
+
class ListRetainedMessagesResponse < Struct.new(
|
258
|
+
:retained_topics,
|
259
|
+
:next_token)
|
260
|
+
SENSITIVE = []
|
261
|
+
include Aws::Structure
|
262
|
+
end
|
263
|
+
|
173
264
|
# The specified combination of HTTP verb and URI is not supported.
|
174
265
|
#
|
175
266
|
# @!attribute [rw] message
|
@@ -190,6 +281,7 @@ module Aws::IoTDataPlane
|
|
190
281
|
# {
|
191
282
|
# topic: "Topic", # required
|
192
283
|
# qos: 1,
|
284
|
+
# retain: false,
|
193
285
|
# payload: "data",
|
194
286
|
# }
|
195
287
|
#
|
@@ -201,13 +293,30 @@ module Aws::IoTDataPlane
|
|
201
293
|
# The Quality of Service (QoS) level.
|
202
294
|
# @return [Integer]
|
203
295
|
#
|
296
|
+
# @!attribute [rw] retain
|
297
|
+
# A Boolean value that determines whether to set the RETAIN flag when
|
298
|
+
# the message is published.
|
299
|
+
#
|
300
|
+
# Setting the RETAIN flag causes the message to be retained and sent
|
301
|
+
# to new subscribers to the topic.
|
302
|
+
#
|
303
|
+
# Valid values: `true` \| `false`
|
304
|
+
#
|
305
|
+
# Default value: `false`
|
306
|
+
# @return [Boolean]
|
307
|
+
#
|
204
308
|
# @!attribute [rw] payload
|
205
|
-
# The
|
309
|
+
# The message body. MQTT accepts text, binary, and empty (null)
|
310
|
+
# message payloads.
|
311
|
+
#
|
312
|
+
# Publishing an empty (null) payload with **retain** = `true` deletes
|
313
|
+
# the retained message identified by **topic** from IoT Core.
|
206
314
|
# @return [String]
|
207
315
|
#
|
208
316
|
class PublishRequest < Struct.new(
|
209
317
|
:topic,
|
210
318
|
:qos,
|
319
|
+
:retain,
|
211
320
|
:payload)
|
212
321
|
SENSITIVE = []
|
213
322
|
include Aws::Structure
|
@@ -237,6 +346,35 @@ module Aws::IoTDataPlane
|
|
237
346
|
include Aws::Structure
|
238
347
|
end
|
239
348
|
|
349
|
+
# Information about a single retained message.
|
350
|
+
#
|
351
|
+
# @!attribute [rw] topic
|
352
|
+
# The topic name to which the retained message was published.
|
353
|
+
# @return [String]
|
354
|
+
#
|
355
|
+
# @!attribute [rw] payload_size
|
356
|
+
# The size of the retained message's payload in bytes.
|
357
|
+
# @return [Integer]
|
358
|
+
#
|
359
|
+
# @!attribute [rw] qos
|
360
|
+
# The quality of service (QoS) level used to publish the retained
|
361
|
+
# message.
|
362
|
+
# @return [Integer]
|
363
|
+
#
|
364
|
+
# @!attribute [rw] last_modified_time
|
365
|
+
# The Epoch date and time, in milliseconds, when the retained message
|
366
|
+
# was stored by IoT.
|
367
|
+
# @return [Integer]
|
368
|
+
#
|
369
|
+
class RetainedMessageSummary < Struct.new(
|
370
|
+
:topic,
|
371
|
+
:payload_size,
|
372
|
+
:qos,
|
373
|
+
:last_modified_time)
|
374
|
+
SENSITIVE = []
|
375
|
+
include Aws::Structure
|
376
|
+
end
|
377
|
+
|
240
378
|
# The service is temporarily unavailable.
|
241
379
|
#
|
242
380
|
# @!attribute [rw] message
|
data/lib/aws-sdk-iotdataplane.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-iotdataplane
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.34.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: 2021-
|
11
|
+
date: 2021-11-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.122.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.122.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
76
76
|
requirements:
|
77
77
|
- - ">="
|
78
78
|
- !ruby/object:Gem::Version
|
79
|
-
version: '
|
79
|
+
version: '2.3'
|
80
80
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
81
81
|
requirements:
|
82
82
|
- - ">="
|