aws-sdk-greengrassv2 1.3.0 → 1.7.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-greengrassv2.rb +2 -2
- data/lib/aws-sdk-greengrassv2/client.rb +243 -75
- data/lib/aws-sdk-greengrassv2/client_api.rb +132 -0
- data/lib/aws-sdk-greengrassv2/errors.rb +16 -0
- data/lib/aws-sdk-greengrassv2/types.rb +519 -150
- metadata +7 -8
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1a07ecfc0a2cbd07740a7c5b9095684493c2efa9943f2deecf5b27551ffd66d8
|
4
|
+
data.tar.gz: 5e5cd49526b0393e67296cbc0dd298c75dc5b475c47be8eaa0e14be33f8ee160
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2619eba7e8425c3378ae9097d4a7b179c15a93ffff0cbf3b42064012012770fc3d5f1d07773e73ad3e2868b469b90411f0c0e9d4f1c6d88eaa8ffb2bf242d9df
|
7
|
+
data.tar.gz: 3314234696d56651287af3a1042465d700407d2fea70d2551a1d182831eba45edf20dd12ddaaf4c8ef437a9623ae3800fab56fbb98711bc4a8c717afff53d8eb
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.7.0 (2021-08-02)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds support for component system resource limits and idempotent Create operations. You can now specify the maximum amount of CPU and memory resources that each component can use.
|
8
|
+
|
9
|
+
1.6.0 (2021-07-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.5.0 (2021-07-28)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.4.0 (2021-06-14)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - We have verified the APIs being released here and are ready to release
|
23
|
+
|
4
24
|
1.3.0 (2021-03-10)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.7.0
|
data/lib/aws-sdk-greengrassv2.rb
CHANGED
@@ -28,7 +28,7 @@ require_relative 'aws-sdk-greengrassv2/customizations'
|
|
28
28
|
# structure.
|
29
29
|
#
|
30
30
|
# greengrass_v2 = Aws::GreengrassV2::Client.new
|
31
|
-
# resp = greengrass_v2.
|
31
|
+
# resp = greengrass_v2.batch_associate_client_device_with_core_device(params)
|
32
32
|
#
|
33
33
|
# See {Client} for more information.
|
34
34
|
#
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-greengrassv2/customizations'
|
|
48
48
|
# @!group service
|
49
49
|
module Aws::GreengrassV2
|
50
50
|
|
51
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.7.0'
|
52
52
|
|
53
53
|
end
|
@@ -327,6 +327,106 @@ module Aws::GreengrassV2
|
|
327
327
|
|
328
328
|
# @!group API Operations
|
329
329
|
|
330
|
+
# Associate a list of client devices with a core device. Use this API
|
331
|
+
# operation to specify which client devices can discover a core device
|
332
|
+
# through cloud discovery. With cloud discovery, client devices connect
|
333
|
+
# to IoT Greengrass to retrieve associated core devices' connectivity
|
334
|
+
# information and certificates. For more information, see [Configure
|
335
|
+
# cloud discovery][1] in the *IoT Greengrass V2 Developer Guide*.
|
336
|
+
#
|
337
|
+
# <note markdown="1"> Client devices are local IoT devices that connect to and communicate
|
338
|
+
# with an IoT Greengrass core device over MQTT. You can connect client
|
339
|
+
# devices to a core device to sync MQTT messages and data to Amazon Web
|
340
|
+
# Services IoT Core and interact with client devices in Greengrass
|
341
|
+
# components. For more information, see [Interact with local IoT
|
342
|
+
# devices][2] in the *IoT Greengrass V2 Developer Guide*.
|
343
|
+
#
|
344
|
+
# </note>
|
345
|
+
#
|
346
|
+
#
|
347
|
+
#
|
348
|
+
# [1]: https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-cloud-discovery.html
|
349
|
+
# [2]: https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html
|
350
|
+
#
|
351
|
+
# @option params [Array<Types::AssociateClientDeviceWithCoreDeviceEntry>] :entries
|
352
|
+
# The list of client devices to associate.
|
353
|
+
#
|
354
|
+
# @option params [required, String] :core_device_thing_name
|
355
|
+
# The name of the core device. This is also the name of the IoT thing.
|
356
|
+
#
|
357
|
+
# @return [Types::BatchAssociateClientDeviceWithCoreDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
358
|
+
#
|
359
|
+
# * {Types::BatchAssociateClientDeviceWithCoreDeviceResponse#error_entries #error_entries} => Array<Types::AssociateClientDeviceWithCoreDeviceErrorEntry>
|
360
|
+
#
|
361
|
+
# @example Request syntax with placeholder values
|
362
|
+
#
|
363
|
+
# resp = client.batch_associate_client_device_with_core_device({
|
364
|
+
# entries: [
|
365
|
+
# {
|
366
|
+
# thing_name: "IoTThingName", # required
|
367
|
+
# },
|
368
|
+
# ],
|
369
|
+
# core_device_thing_name: "IoTThingName", # required
|
370
|
+
# })
|
371
|
+
#
|
372
|
+
# @example Response structure
|
373
|
+
#
|
374
|
+
# resp.error_entries #=> Array
|
375
|
+
# resp.error_entries[0].thing_name #=> String
|
376
|
+
# resp.error_entries[0].code #=> String
|
377
|
+
# resp.error_entries[0].message #=> String
|
378
|
+
#
|
379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/BatchAssociateClientDeviceWithCoreDevice AWS API Documentation
|
380
|
+
#
|
381
|
+
# @overload batch_associate_client_device_with_core_device(params = {})
|
382
|
+
# @param [Hash] params ({})
|
383
|
+
def batch_associate_client_device_with_core_device(params = {}, options = {})
|
384
|
+
req = build_request(:batch_associate_client_device_with_core_device, params)
|
385
|
+
req.send_request(options)
|
386
|
+
end
|
387
|
+
|
388
|
+
# Disassociate a list of client devices from a core device. After you
|
389
|
+
# disassociate a client device from a core device, the client device
|
390
|
+
# won't be able to use cloud discovery to retrieve the core device's
|
391
|
+
# connectivity information and certificates.
|
392
|
+
#
|
393
|
+
# @option params [Array<Types::DisassociateClientDeviceFromCoreDeviceEntry>] :entries
|
394
|
+
# The list of client devices to disassociate.
|
395
|
+
#
|
396
|
+
# @option params [required, String] :core_device_thing_name
|
397
|
+
# The name of the core device. This is also the name of the IoT thing.
|
398
|
+
#
|
399
|
+
# @return [Types::BatchDisassociateClientDeviceFromCoreDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
400
|
+
#
|
401
|
+
# * {Types::BatchDisassociateClientDeviceFromCoreDeviceResponse#error_entries #error_entries} => Array<Types::DisassociateClientDeviceFromCoreDeviceErrorEntry>
|
402
|
+
#
|
403
|
+
# @example Request syntax with placeholder values
|
404
|
+
#
|
405
|
+
# resp = client.batch_disassociate_client_device_from_core_device({
|
406
|
+
# entries: [
|
407
|
+
# {
|
408
|
+
# thing_name: "IoTThingName", # required
|
409
|
+
# },
|
410
|
+
# ],
|
411
|
+
# core_device_thing_name: "IoTThingName", # required
|
412
|
+
# })
|
413
|
+
#
|
414
|
+
# @example Response structure
|
415
|
+
#
|
416
|
+
# resp.error_entries #=> Array
|
417
|
+
# resp.error_entries[0].thing_name #=> String
|
418
|
+
# resp.error_entries[0].code #=> String
|
419
|
+
# resp.error_entries[0].message #=> String
|
420
|
+
#
|
421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/BatchDisassociateClientDeviceFromCoreDevice AWS API Documentation
|
422
|
+
#
|
423
|
+
# @overload batch_disassociate_client_device_from_core_device(params = {})
|
424
|
+
# @param [Hash] params ({})
|
425
|
+
def batch_disassociate_client_device_from_core_device(params = {}, options = {})
|
426
|
+
req = build_request(:batch_disassociate_client_device_from_core_device, params)
|
427
|
+
req.send_request(options)
|
428
|
+
end
|
429
|
+
|
330
430
|
# Cancels a deployment. This operation cancels the deployment for
|
331
431
|
# devices that haven't yet received it. If a device already received
|
332
432
|
# the deployment, this operation doesn't change anything for that
|
@@ -358,11 +458,10 @@ module Aws::GreengrassV2
|
|
358
458
|
req.send_request(options)
|
359
459
|
end
|
360
460
|
|
361
|
-
# Creates a component. Components are software that run on
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
365
|
-
# core devices.
|
461
|
+
# Creates a component. Components are software that run on Greengrass
|
462
|
+
# core devices. After you develop and test a component on your core
|
463
|
+
# device, you can use this operation to upload your component to IoT
|
464
|
+
# Greengrass. Then, you can deploy the component to other core devices.
|
366
465
|
#
|
367
466
|
# You can use this operation to do the following:
|
368
467
|
#
|
@@ -370,20 +469,20 @@ module Aws::GreengrassV2
|
|
370
469
|
#
|
371
470
|
# Create a component from a recipe, which is a file that defines the
|
372
471
|
# component's metadata, parameters, dependencies, lifecycle,
|
373
|
-
# artifacts, and platform capability. For more information, see [
|
374
|
-
#
|
375
|
-
#
|
472
|
+
# artifacts, and platform capability. For more information, see [IoT
|
473
|
+
# Greengrass component recipe reference][1] in the *IoT Greengrass V2
|
474
|
+
# Developer Guide*.
|
376
475
|
#
|
377
476
|
# To create a component from a recipe, specify `inlineRecipe` when you
|
378
477
|
# call this operation.
|
379
478
|
#
|
380
479
|
# * **Create components from Lambda functions**
|
381
480
|
#
|
382
|
-
# Create a component from an
|
481
|
+
# Create a component from an Lambda function that runs on IoT
|
383
482
|
# Greengrass. This creates a recipe and artifacts from the Lambda
|
384
483
|
# function's deployment package. You can use this operation to
|
385
|
-
# migrate Lambda functions from
|
386
|
-
#
|
484
|
+
# migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass
|
485
|
+
# V2.
|
387
486
|
#
|
388
487
|
# This function only accepts Lambda functions that use the following
|
389
488
|
# runtimes:
|
@@ -421,13 +520,26 @@ module Aws::GreengrassV2
|
|
421
520
|
#
|
422
521
|
# @option params [Hash<String,String>] :tags
|
423
522
|
# A list of key-value pairs that contain metadata for the resource. For
|
424
|
-
# more information, see [Tag your resources][1] in the *
|
425
|
-
#
|
523
|
+
# more information, see [Tag your resources][1] in the *IoT Greengrass
|
524
|
+
# V2 Developer Guide*.
|
426
525
|
#
|
427
526
|
#
|
428
527
|
#
|
429
528
|
# [1]: https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html
|
430
529
|
#
|
530
|
+
# @option params [String] :client_token
|
531
|
+
# A unique, case-sensitive identifier that you can provide to ensure
|
532
|
+
# that the request is idempotent. Idempotency means that the request is
|
533
|
+
# successfully processed only once, even if you send the request
|
534
|
+
# multiple times. When a request succeeds, and you specify the same
|
535
|
+
# client token for subsequent successful requests, the IoT Greengrass V2
|
536
|
+
# service returns the successful response that it caches from the
|
537
|
+
# previous request. IoT Greengrass V2 caches successful responses for
|
538
|
+
# idempotent requests for up to 8 hours.
|
539
|
+
#
|
540
|
+
# **A suitable default value is auto-generated.** You should normally
|
541
|
+
# not need to pass this option.**
|
542
|
+
#
|
431
543
|
# @return [Types::CreateComponentVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
432
544
|
#
|
433
545
|
# * {Types::CreateComponentVersionResponse#arn #arn} => String
|
@@ -503,6 +615,7 @@ module Aws::GreengrassV2
|
|
503
615
|
# tags: {
|
504
616
|
# "TagKey" => "TagValue",
|
505
617
|
# },
|
618
|
+
# client_token: "ClientTokenString",
|
506
619
|
# })
|
507
620
|
#
|
508
621
|
# @example Response structure
|
@@ -525,22 +638,22 @@ module Aws::GreengrassV2
|
|
525
638
|
req.send_request(options)
|
526
639
|
end
|
527
640
|
|
528
|
-
# Creates a continuous deployment for a target, which is a
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
641
|
+
# Creates a continuous deployment for a target, which is a Greengrass
|
642
|
+
# core device or group of core devices. When you add a new core device
|
643
|
+
# to a group of core devices that has a deployment, IoT Greengrass
|
644
|
+
# deploys that group's deployment to the new device.
|
532
645
|
#
|
533
646
|
# You can define one deployment for each target. When you create a new
|
534
647
|
# deployment for a target that has an existing deployment, you replace
|
535
|
-
# the previous deployment.
|
536
|
-
#
|
648
|
+
# the previous deployment. IoT Greengrass applies the new deployment to
|
649
|
+
# the target devices.
|
537
650
|
#
|
538
651
|
# Every deployment has a revision number that indicates how many
|
539
652
|
# deployment revisions you define for a target. Use this operation to
|
540
653
|
# create a new revision of an existing deployment. This operation
|
541
654
|
# returns the revision number of the new deployment when you create it.
|
542
655
|
#
|
543
|
-
# For more information, see the [Create deployments][1] in the *
|
656
|
+
# For more information, see the [Create deployments][1] in the *IoT
|
544
657
|
# Greengrass V2 Developer Guide*.
|
545
658
|
#
|
546
659
|
#
|
@@ -548,7 +661,7 @@ module Aws::GreengrassV2
|
|
548
661
|
# [1]: https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html
|
549
662
|
#
|
550
663
|
# @option params [required, String] :target_arn
|
551
|
-
# The [ARN][1] of the target
|
664
|
+
# The [ARN][1] of the target IoT thing or thing group.
|
552
665
|
#
|
553
666
|
#
|
554
667
|
#
|
@@ -557,11 +670,6 @@ module Aws::GreengrassV2
|
|
557
670
|
# @option params [String] :deployment_name
|
558
671
|
# The name of the deployment.
|
559
672
|
#
|
560
|
-
# You can create deployments without names. If you create a deployment
|
561
|
-
# without a name, the AWS IoT Greengrass V2 console shows the deployment
|
562
|
-
# name as `<targetType>:<targetName>`, where `targetType` and
|
563
|
-
# `targetName` are the type and name of the deployment target.
|
564
|
-
#
|
565
673
|
# @option params [Hash<String,Types::ComponentDeploymentSpecification>] :components
|
566
674
|
# The components to deploy. This is a dictionary, where each key is the
|
567
675
|
# name of a component, and each key's value is the version and
|
@@ -578,13 +686,26 @@ module Aws::GreengrassV2
|
|
578
686
|
#
|
579
687
|
# @option params [Hash<String,String>] :tags
|
580
688
|
# A list of key-value pairs that contain metadata for the resource. For
|
581
|
-
# more information, see [Tag your resources][1] in the *
|
582
|
-
#
|
689
|
+
# more information, see [Tag your resources][1] in the *IoT Greengrass
|
690
|
+
# V2 Developer Guide*.
|
583
691
|
#
|
584
692
|
#
|
585
693
|
#
|
586
694
|
# [1]: https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html
|
587
695
|
#
|
696
|
+
# @option params [String] :client_token
|
697
|
+
# A unique, case-sensitive identifier that you can provide to ensure
|
698
|
+
# that the request is idempotent. Idempotency means that the request is
|
699
|
+
# successfully processed only once, even if you send the request
|
700
|
+
# multiple times. When a request succeeds, and you specify the same
|
701
|
+
# client token for subsequent successful requests, the IoT Greengrass V2
|
702
|
+
# service returns the successful response that it caches from the
|
703
|
+
# previous request. IoT Greengrass V2 caches successful responses for
|
704
|
+
# idempotent requests for up to 8 hours.
|
705
|
+
#
|
706
|
+
# **A suitable default value is auto-generated.** You should normally
|
707
|
+
# not need to pass this option.**
|
708
|
+
#
|
588
709
|
# @return [Types::CreateDeploymentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
589
710
|
#
|
590
711
|
# * {Types::CreateDeploymentResponse#deployment_id #deployment_id} => String
|
@@ -605,6 +726,10 @@ module Aws::GreengrassV2
|
|
605
726
|
# },
|
606
727
|
# run_with: {
|
607
728
|
# posix_user: "NonEmptyString",
|
729
|
+
# system_resource_limits: {
|
730
|
+
# memory: 1,
|
731
|
+
# cpus: 1.0,
|
732
|
+
# },
|
608
733
|
# },
|
609
734
|
# },
|
610
735
|
# },
|
@@ -647,6 +772,7 @@ module Aws::GreengrassV2
|
|
647
772
|
# tags: {
|
648
773
|
# "TagKey" => "TagValue",
|
649
774
|
# },
|
775
|
+
# client_token: "ClientTokenString",
|
650
776
|
# })
|
651
777
|
#
|
652
778
|
# @example Response structure
|
@@ -664,7 +790,7 @@ module Aws::GreengrassV2
|
|
664
790
|
req.send_request(options)
|
665
791
|
end
|
666
792
|
|
667
|
-
# Deletes a version of a component from
|
793
|
+
# Deletes a version of a component from IoT Greengrass.
|
668
794
|
#
|
669
795
|
# <note markdown="1"> This operation deletes the component's recipe and artifacts. As a
|
670
796
|
# result, deployments that refer to this component version will fail. If
|
@@ -698,19 +824,18 @@ module Aws::GreengrassV2
|
|
698
824
|
req.send_request(options)
|
699
825
|
end
|
700
826
|
|
701
|
-
# Deletes a
|
702
|
-
#
|
703
|
-
#
|
704
|
-
#
|
705
|
-
#
|
827
|
+
# Deletes a Greengrass core device, which is an IoT thing. This
|
828
|
+
# operation removes the core device from the list of core devices. This
|
829
|
+
# operation doesn't delete the IoT thing. For more information about
|
830
|
+
# how to delete the IoT thing, see [DeleteThing][1] in the *IoT API
|
831
|
+
# Reference*.
|
706
832
|
#
|
707
833
|
#
|
708
834
|
#
|
709
835
|
# [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteThing.html
|
710
836
|
#
|
711
837
|
# @option params [required, String] :core_device_thing_name
|
712
|
-
# The name of the core device. This is also the name of the
|
713
|
-
# thing.
|
838
|
+
# The name of the core device. This is also the name of the IoT thing.
|
714
839
|
#
|
715
840
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
716
841
|
#
|
@@ -876,11 +1001,10 @@ module Aws::GreengrassV2
|
|
876
1001
|
req.send_request(options)
|
877
1002
|
end
|
878
1003
|
|
879
|
-
# Retrieves metadata for a
|
1004
|
+
# Retrieves metadata for a Greengrass core device.
|
880
1005
|
#
|
881
1006
|
# @option params [required, String] :core_device_thing_name
|
882
|
-
# The name of the core device. This is also the name of the
|
883
|
-
# thing.
|
1007
|
+
# The name of the core device. This is also the name of the IoT thing.
|
884
1008
|
#
|
885
1009
|
# @return [Types::GetCoreDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
886
1010
|
#
|
@@ -918,8 +1042,8 @@ module Aws::GreengrassV2
|
|
918
1042
|
req.send_request(options)
|
919
1043
|
end
|
920
1044
|
|
921
|
-
# Gets a deployment. Deployments define the components that run on
|
922
|
-
#
|
1045
|
+
# Gets a deployment. Deployments define the components that run on
|
1046
|
+
# Greengrass core devices.
|
923
1047
|
#
|
924
1048
|
# @option params [required, String] :deployment_id
|
925
1049
|
# The ID of the deployment.
|
@@ -961,6 +1085,8 @@ module Aws::GreengrassV2
|
|
961
1085
|
# resp.components["NonEmptyString"].configuration_update.reset #=> Array
|
962
1086
|
# resp.components["NonEmptyString"].configuration_update.reset[0] #=> String
|
963
1087
|
# resp.components["NonEmptyString"].run_with.posix_user #=> String
|
1088
|
+
# resp.components["NonEmptyString"].run_with.system_resource_limits.memory #=> Integer
|
1089
|
+
# resp.components["NonEmptyString"].run_with.system_resource_limits.cpus #=> Float
|
964
1090
|
# resp.deployment_policies.failure_handling_policy #=> String, one of "ROLLBACK", "DO_NOTHING"
|
965
1091
|
# resp.deployment_policies.component_update_policy.timeout_in_seconds #=> Integer
|
966
1092
|
# resp.deployment_policies.component_update_policy.action #=> String, one of "NOTIFY_COMPONENTS", "SKIP_NOTIFY_COMPONENTS"
|
@@ -990,7 +1116,51 @@ module Aws::GreengrassV2
|
|
990
1116
|
req.send_request(options)
|
991
1117
|
end
|
992
1118
|
|
993
|
-
# Retrieves a paginated list of
|
1119
|
+
# Retrieves a paginated list of client devices that are associated with
|
1120
|
+
# a core device.
|
1121
|
+
#
|
1122
|
+
# @option params [required, String] :core_device_thing_name
|
1123
|
+
# The name of the core device. This is also the name of the IoT thing.
|
1124
|
+
#
|
1125
|
+
# @option params [Integer] :max_results
|
1126
|
+
# The maximum number of results to be returned per paginated request.
|
1127
|
+
#
|
1128
|
+
# @option params [String] :next_token
|
1129
|
+
# The token to be used for the next set of paginated results.
|
1130
|
+
#
|
1131
|
+
# @return [Types::ListClientDevicesAssociatedWithCoreDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1132
|
+
#
|
1133
|
+
# * {Types::ListClientDevicesAssociatedWithCoreDeviceResponse#associated_client_devices #associated_client_devices} => Array<Types::AssociatedClientDevice>
|
1134
|
+
# * {Types::ListClientDevicesAssociatedWithCoreDeviceResponse#next_token #next_token} => String
|
1135
|
+
#
|
1136
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1137
|
+
#
|
1138
|
+
# @example Request syntax with placeholder values
|
1139
|
+
#
|
1140
|
+
# resp = client.list_client_devices_associated_with_core_device({
|
1141
|
+
# core_device_thing_name: "IoTThingName", # required
|
1142
|
+
# max_results: 1,
|
1143
|
+
# next_token: "NextTokenString",
|
1144
|
+
# })
|
1145
|
+
#
|
1146
|
+
# @example Response structure
|
1147
|
+
#
|
1148
|
+
# resp.associated_client_devices #=> Array
|
1149
|
+
# resp.associated_client_devices[0].thing_name #=> String
|
1150
|
+
# resp.associated_client_devices[0].association_timestamp #=> Time
|
1151
|
+
# resp.next_token #=> String
|
1152
|
+
#
|
1153
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListClientDevicesAssociatedWithCoreDevice AWS API Documentation
|
1154
|
+
#
|
1155
|
+
# @overload list_client_devices_associated_with_core_device(params = {})
|
1156
|
+
# @param [Hash] params ({})
|
1157
|
+
def list_client_devices_associated_with_core_device(params = {}, options = {})
|
1158
|
+
req = build_request(:list_client_devices_associated_with_core_device, params)
|
1159
|
+
req.send_request(options)
|
1160
|
+
end
|
1161
|
+
|
1162
|
+
# Retrieves a paginated list of all versions for a component. Greater
|
1163
|
+
# versions are listed first.
|
994
1164
|
#
|
995
1165
|
# @option params [required, String] :arn
|
996
1166
|
# The [ARN][1] of the component version.
|
@@ -1091,12 +1261,12 @@ module Aws::GreengrassV2
|
|
1091
1261
|
req.send_request(options)
|
1092
1262
|
end
|
1093
1263
|
|
1094
|
-
# Retrieves a paginated list of
|
1264
|
+
# Retrieves a paginated list of Greengrass core devices.
|
1095
1265
|
#
|
1096
1266
|
# @option params [String] :thing_group_arn
|
1097
|
-
# The [ARN][1] of the
|
1098
|
-
#
|
1099
|
-
#
|
1267
|
+
# The [ARN][1] of the IoT thing group by which to filter. If you specify
|
1268
|
+
# this parameter, the list includes only core devices that are members
|
1269
|
+
# of this thing group.
|
1100
1270
|
#
|
1101
1271
|
#
|
1102
1272
|
#
|
@@ -1107,11 +1277,11 @@ module Aws::GreengrassV2
|
|
1107
1277
|
# parameter, the list includes only core devices that have this status.
|
1108
1278
|
# Choose one of the following options:
|
1109
1279
|
#
|
1110
|
-
# * `HEALTHY` – The
|
1111
|
-
#
|
1280
|
+
# * `HEALTHY` – The IoT Greengrass Core software and all components run
|
1281
|
+
# on the core device without issue.
|
1112
1282
|
#
|
1113
|
-
# * `UNHEALTHY` – The
|
1114
|
-
#
|
1283
|
+
# * `UNHEALTHY` – The IoT Greengrass Core software or a component is in
|
1284
|
+
# a failed state on the core device.
|
1115
1285
|
#
|
1116
1286
|
# @option params [Integer] :max_results
|
1117
1287
|
# The maximum number of results to be returned per paginated request.
|
@@ -1155,7 +1325,7 @@ module Aws::GreengrassV2
|
|
1155
1325
|
# Retrieves a paginated list of deployments.
|
1156
1326
|
#
|
1157
1327
|
# @option params [String] :target_arn
|
1158
|
-
# The [ARN][1] of the target
|
1328
|
+
# The [ARN][1] of the target IoT thing or thing group.
|
1159
1329
|
#
|
1160
1330
|
#
|
1161
1331
|
#
|
@@ -1215,12 +1385,11 @@ module Aws::GreengrassV2
|
|
1215
1385
|
req.send_request(options)
|
1216
1386
|
end
|
1217
1387
|
|
1218
|
-
# Retrieves a paginated list of deployment jobs that
|
1219
|
-
# sends to
|
1388
|
+
# Retrieves a paginated list of deployment jobs that IoT Greengrass
|
1389
|
+
# sends to Greengrass core devices.
|
1220
1390
|
#
|
1221
1391
|
# @option params [required, String] :core_device_thing_name
|
1222
|
-
# The name of the core device. This is also the name of the
|
1223
|
-
# thing.
|
1392
|
+
# The name of the core device. This is also the name of the IoT thing.
|
1224
1393
|
#
|
1225
1394
|
# @option params [Integer] :max_results
|
1226
1395
|
# The maximum number of results to be returned per paginated request.
|
@@ -1267,12 +1436,11 @@ module Aws::GreengrassV2
|
|
1267
1436
|
req.send_request(options)
|
1268
1437
|
end
|
1269
1438
|
|
1270
|
-
# Retrieves a paginated list of the components that a
|
1271
|
-
#
|
1439
|
+
# Retrieves a paginated list of the components that a Greengrass core
|
1440
|
+
# device runs.
|
1272
1441
|
#
|
1273
1442
|
# @option params [required, String] :core_device_thing_name
|
1274
|
-
# The name of the core device. This is also the name of the
|
1275
|
-
# thing.
|
1443
|
+
# The name of the core device. This is also the name of the IoT thing.
|
1276
1444
|
#
|
1277
1445
|
# @option params [Integer] :max_results
|
1278
1446
|
# The maximum number of results to be returned per paginated request.
|
@@ -1314,7 +1482,7 @@ module Aws::GreengrassV2
|
|
1314
1482
|
req.send_request(options)
|
1315
1483
|
end
|
1316
1484
|
|
1317
|
-
# Retrieves the list of tags for an
|
1485
|
+
# Retrieves the list of tags for an IoT Greengrass resource.
|
1318
1486
|
#
|
1319
1487
|
# @option params [required, String] :resource_arn
|
1320
1488
|
# The [ARN][1] of the resource.
|
@@ -1348,8 +1516,8 @@ module Aws::GreengrassV2
|
|
1348
1516
|
end
|
1349
1517
|
|
1350
1518
|
# Retrieves a list of components that meet the component, version, and
|
1351
|
-
# platform requirements of a deployment.
|
1352
|
-
#
|
1519
|
+
# platform requirements of a deployment. Greengrass core devices call
|
1520
|
+
# this operation when they receive a deployment to identify the
|
1353
1521
|
# components to install.
|
1354
1522
|
#
|
1355
1523
|
# This operation identifies components that meet all dependency
|
@@ -1358,15 +1526,15 @@ module Aws::GreengrassV2
|
|
1358
1526
|
# occurs if component `A` requires version `>2.0.0` and component `B`
|
1359
1527
|
# requires version `<2.0.0` of a component dependency.
|
1360
1528
|
#
|
1361
|
-
# When you specify the component candidates to resolve,
|
1362
|
-
#
|
1363
|
-
#
|
1364
|
-
# then
|
1365
|
-
# Cloud.
|
1529
|
+
# When you specify the component candidates to resolve, IoT Greengrass
|
1530
|
+
# compares each component's digest from the core device with the
|
1531
|
+
# component's digest in the Amazon Web Services Cloud. If the digests
|
1532
|
+
# don't match, then IoT Greengrass specifies to use the version from
|
1533
|
+
# the Amazon Web Services Cloud.
|
1366
1534
|
#
|
1367
1535
|
# To use this operation, you must use the data plane API endpoint and
|
1368
|
-
# authenticate with an
|
1369
|
-
#
|
1536
|
+
# authenticate with an IoT device certificate. For more information, see
|
1537
|
+
# [IoT Greengrass endpoints and quotas][1].
|
1370
1538
|
#
|
1371
1539
|
#
|
1372
1540
|
#
|
@@ -1419,8 +1587,8 @@ module Aws::GreengrassV2
|
|
1419
1587
|
req.send_request(options)
|
1420
1588
|
end
|
1421
1589
|
|
1422
|
-
# Adds tags to an
|
1423
|
-
#
|
1590
|
+
# Adds tags to an IoT Greengrass resource. If a tag already exists for
|
1591
|
+
# the resource, this operation updates the tag's value.
|
1424
1592
|
#
|
1425
1593
|
# @option params [required, String] :resource_arn
|
1426
1594
|
# The [ARN][1] of the resource to tag.
|
@@ -1431,8 +1599,8 @@ module Aws::GreengrassV2
|
|
1431
1599
|
#
|
1432
1600
|
# @option params [required, Hash<String,String>] :tags
|
1433
1601
|
# A list of key-value pairs that contain metadata for the resource. For
|
1434
|
-
# more information, see [Tag your resources][1] in the *
|
1435
|
-
#
|
1602
|
+
# more information, see [Tag your resources][1] in the *IoT Greengrass
|
1603
|
+
# V2 Developer Guide*.
|
1436
1604
|
#
|
1437
1605
|
#
|
1438
1606
|
#
|
@@ -1458,7 +1626,7 @@ module Aws::GreengrassV2
|
|
1458
1626
|
req.send_request(options)
|
1459
1627
|
end
|
1460
1628
|
|
1461
|
-
# Removes a tag from an
|
1629
|
+
# Removes a tag from an IoT Greengrass resource.
|
1462
1630
|
#
|
1463
1631
|
# @option params [required, String] :resource_arn
|
1464
1632
|
# The [ARN][1] of the resource to untag.
|
@@ -1501,7 +1669,7 @@ module Aws::GreengrassV2
|
|
1501
1669
|
params: params,
|
1502
1670
|
config: config)
|
1503
1671
|
context[:gem_name] = 'aws-sdk-greengrassv2'
|
1504
|
-
context[:gem_version] = '1.
|
1672
|
+
context[:gem_version] = '1.7.0'
|
1505
1673
|
Seahorse::Client::Request.new(handlers, context)
|
1506
1674
|
end
|
1507
1675
|
|