Skip to content

Commit 5f349e0

Browse files
author
AWS
committed
AWS IoT Greengrass V2 Update: We have verified the APIs being released here and are ready to release
1 parent 977f71a commit 5f349e0

File tree

3 files changed

+264
-1
lines changed

3 files changed

+264
-1
lines changed

‎.changes/next-release/feature-AWSIoTGreengrassV2-093d94b.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS IoT Greengrass V2",
4+
"contributor": "",
5+
"description": "We have verified the APIs being released here and are ready to release"
6+
}

‎services/greengrassv2/src/main/resources/codegen-resources/paginators-1.json

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
{
22
"pagination": {
3+
"ListClientDevicesAssociatedWithCoreDevice": {
4+
"input_token": "nextToken",
5+
"output_token": "nextToken",
6+
"limit_key": "maxResults",
7+
"result_key": "associatedClientDevices"
8+
},
39
"ListComponentVersions": {
410
"input_token": "nextToken",
511
"output_token": "nextToken",

‎services/greengrassv2/src/main/resources/codegen-resources/service-2.json

+252-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,42 @@
1212
"uid":"greengrassv2-2020-11-30"
1313
},
1414
"operations":{
15+
"BatchAssociateClientDeviceWithCoreDevice":{
16+
"name":"BatchAssociateClientDeviceWithCoreDevice",
17+
"http":{
18+
"method":"POST",
19+
"requestUri":"/greengrass/v2/coreDevices/{coreDeviceThingName}/associateClientDevices",
20+
"responseCode":200
21+
},
22+
"input":{"shape":"BatchAssociateClientDeviceWithCoreDeviceRequest"},
23+
"output":{"shape":"BatchAssociateClientDeviceWithCoreDeviceResponse"},
24+
"errors":[
25+
{"shape":"ValidationException"},
26+
{"shape":"ResourceNotFoundException"},
27+
{"shape":"AccessDeniedException"},
28+
{"shape":"InternalServerException"},
29+
{"shape":"ThrottlingException"}
30+
],
31+
"documentation":"<p>Associate a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to AWS IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-cloud-discovery.html\">Configure cloud discovery</a> in the <i>AWS IoT Greengrass V2 Developer Guide</i>.</p> <note> <p>Client devices are local IoT devices that connect to and communicate with an AWS IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to AWS IoT Core and interact with client devices in AWS IoT Greengrass components. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html\">Interact with local IoT devices</a> in the <i>AWS IoT Greengrass V2 Developer Guide</i>.</p> </note>"
32+
},
33+
"BatchDisassociateClientDeviceFromCoreDevice":{
34+
"name":"BatchDisassociateClientDeviceFromCoreDevice",
35+
"http":{
36+
"method":"POST",
37+
"requestUri":"/greengrass/v2/coreDevices/{coreDeviceThingName}/disassociateClientDevices",
38+
"responseCode":200
39+
},
40+
"input":{"shape":"BatchDisassociateClientDeviceFromCoreDeviceRequest"},
41+
"output":{"shape":"BatchDisassociateClientDeviceFromCoreDeviceResponse"},
42+
"errors":[
43+
{"shape":"ValidationException"},
44+
{"shape":"ResourceNotFoundException"},
45+
{"shape":"AccessDeniedException"},
46+
{"shape":"InternalServerException"},
47+
{"shape":"ThrottlingException"}
48+
],
49+
"documentation":"<p>Disassociate a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.</p>"
50+
},
1551
"CancelDeployment":{
1652
"name":"CancelDeployment",
1753
"http":{
@@ -188,6 +224,24 @@
188224
],
189225
"documentation":"<p>Gets a deployment. Deployments define the components that run on AWS IoT Greengrass core devices.</p>"
190226
},
227+
"ListClientDevicesAssociatedWithCoreDevice":{
228+
"name":"ListClientDevicesAssociatedWithCoreDevice",
229+
"http":{
230+
"method":"GET",
231+
"requestUri":"/greengrass/v2/coreDevices/{coreDeviceThingName}/associatedClientDevices",
232+
"responseCode":200
233+
},
234+
"input":{"shape":"ListClientDevicesAssociatedWithCoreDeviceRequest"},
235+
"output":{"shape":"ListClientDevicesAssociatedWithCoreDeviceResponse"},
236+
"errors":[
237+
{"shape":"ValidationException"},
238+
{"shape":"ResourceNotFoundException"},
239+
{"shape":"AccessDeniedException"},
240+
{"shape":"InternalServerException"},
241+
{"shape":"ThrottlingException"}
242+
],
243+
"documentation":"<p>Retrieves a paginated list of client devices that are associated with a core device.</p>"
244+
},
191245
"ListComponentVersions":{
192246
"name":"ListComponentVersions",
193247
"http":{
@@ -203,7 +257,7 @@
203257
{"shape":"ThrottlingException"},
204258
{"shape":"InternalServerException"}
205259
],
206-
"documentation":"<p>Retrieves a paginated list of all versions for a component.</p>"
260+
"documentation":"<p>Retrieves a paginated list of all versions for a component. Greater versions are listed first.</p>"
207261
},
208262
"ListComponents":{
209263
"name":"ListComponents",
@@ -362,6 +416,117 @@
362416
"error":{"httpStatusCode":403},
363417
"exception":true
364418
},
419+
"AssociateClientDeviceWithCoreDeviceEntry":{
420+
"type":"structure",
421+
"required":["thingName"],
422+
"members":{
423+
"thingName":{
424+
"shape":"IoTThingName",
425+
"documentation":"<p>The name of the AWS IoT thing that represents the client device to associate.</p>"
426+
}
427+
},
428+
"documentation":"<p>Contains a request to associate a client device with a core device. The <a href=\"https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html\">BatchAssociateClientDeviceWithCoreDevice</a> operation consumes a list of these requests.</p>"
429+
},
430+
"AssociateClientDeviceWithCoreDeviceEntryList":{
431+
"type":"list",
432+
"member":{"shape":"AssociateClientDeviceWithCoreDeviceEntry"},
433+
"max":100,
434+
"min":1
435+
},
436+
"AssociateClientDeviceWithCoreDeviceErrorEntry":{
437+
"type":"structure",
438+
"members":{
439+
"thingName":{
440+
"shape":"IoTThingName",
441+
"documentation":"<p>The name of the AWS IoT thing whose associate request failed.</p>"
442+
},
443+
"code":{
444+
"shape":"NonEmptyString",
445+
"documentation":"<p>The error code for the request.</p>"
446+
},
447+
"message":{
448+
"shape":"NonEmptyString",
449+
"documentation":"<p>A message that provides additional information about the error.</p>"
450+
}
451+
},
452+
"documentation":"<p>Contains an error that occurs from a request to associate a client device with a core device. The <a href=\"https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html\">BatchAssociateClientDeviceWithCoreDevice</a> operation returns a list of these errors.</p>"
453+
},
454+
"AssociateClientDeviceWithCoreDeviceErrorList":{
455+
"type":"list",
456+
"member":{"shape":"AssociateClientDeviceWithCoreDeviceErrorEntry"},
457+
"max":100,
458+
"min":1
459+
},
460+
"AssociatedClientDevice":{
461+
"type":"structure",
462+
"members":{
463+
"thingName":{
464+
"shape":"IoTThingName",
465+
"documentation":"<p>The name of the AWS IoT thing that represents the associated client device.</p>"
466+
},
467+
"associationTimestamp":{
468+
"shape":"Timestamp",
469+
"documentation":"<p>The time that the client device was associated, expressed in ISO 8601 format.</p>"
470+
}
471+
},
472+
"documentation":"<p>Contains information about a client device that is associated to a core device for cloud discovery.</p>"
473+
},
474+
"AssociatedClientDeviceList":{
475+
"type":"list",
476+
"member":{"shape":"AssociatedClientDevice"},
477+
"max":100,
478+
"min":1
479+
},
480+
"BatchAssociateClientDeviceWithCoreDeviceRequest":{
481+
"type":"structure",
482+
"required":["coreDeviceThingName"],
483+
"members":{
484+
"entries":{
485+
"shape":"AssociateClientDeviceWithCoreDeviceEntryList",
486+
"documentation":"<p>The list of client devices to associate.</p>"
487+
},
488+
"coreDeviceThingName":{
489+
"shape":"IoTThingName",
490+
"documentation":"<p>The name of the core device. This is also the name of the AWS IoT thing.</p>",
491+
"location":"uri",
492+
"locationName":"coreDeviceThingName"
493+
}
494+
}
495+
},
496+
"BatchAssociateClientDeviceWithCoreDeviceResponse":{
497+
"type":"structure",
498+
"members":{
499+
"errorEntries":{
500+
"shape":"AssociateClientDeviceWithCoreDeviceErrorList",
501+
"documentation":"<p>The list of any errors for the entries in the request. Each error entry contains the name of the AWS IoT thing that failed to associate.</p>"
502+
}
503+
}
504+
},
505+
"BatchDisassociateClientDeviceFromCoreDeviceRequest":{
506+
"type":"structure",
507+
"required":["coreDeviceThingName"],
508+
"members":{
509+
"entries":{
510+
"shape":"DisassociateClientDeviceFromCoreDeviceEntryList",
511+
"documentation":"<p>The list of client devices to disassociate.</p>"
512+
},
513+
"coreDeviceThingName":{
514+
"shape":"IoTThingName",
515+
"documentation":"<p>The name of the core device. This is also the name of the AWS IoT thing.</p>",
516+
"location":"uri",
517+
"locationName":"coreDeviceThingName"
518+
}
519+
}
520+
},
521+
"BatchDisassociateClientDeviceFromCoreDeviceResponse":{
522+
"type":"structure",
523+
"members":{
524+
"errorEntries":{
525+
"shape":"DisassociateClientDeviceFromCoreDeviceErrorList",
526+
"documentation":"<p>The list of errors (if any) for the entries in the request. Each error entry contains the name of the AWS IoT thing that failed to disassociate.</p>"
527+
}
528+
}
529+
},
365530
"CancelDeploymentRequest":{
366531
"type":"structure",
367532
"required":["deploymentId"],
@@ -1026,6 +1191,47 @@
10261191
"min":1
10271192
},
10281193
"DescriptionString":{"type":"string"},
1194+
"DisassociateClientDeviceFromCoreDeviceEntry":{
1195+
"type":"structure",
1196+
"required":["thingName"],
1197+
"members":{
1198+
"thingName":{
1199+
"shape":"IoTThingName",
1200+
"documentation":"<p>The name of the AWS IoT thing that represents the client device to disassociate.</p>"
1201+
}
1202+
},
1203+
"documentation":"<p>Contains a request to disassociate a client device from a core device. The <a href=\"https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html\">BatchDisassociateClientDeviceWithCoreDevice</a> operation consumes a list of these requests.</p>"
1204+
},
1205+
"DisassociateClientDeviceFromCoreDeviceEntryList":{
1206+
"type":"list",
1207+
"member":{"shape":"DisassociateClientDeviceFromCoreDeviceEntry"},
1208+
"max":100,
1209+
"min":1
1210+
},
1211+
"DisassociateClientDeviceFromCoreDeviceErrorEntry":{
1212+
"type":"structure",
1213+
"members":{
1214+
"thingName":{
1215+
"shape":"IoTThingName",
1216+
"documentation":"<p>The name of the AWS IoT thing whose disassociate request failed.</p>"
1217+
},
1218+
"code":{
1219+
"shape":"NonEmptyString",
1220+
"documentation":"<p>The error code for the request.</p>"
1221+
},
1222+
"message":{
1223+
"shape":"NonEmptyString",
1224+
"documentation":"<p>A message that provides additional information about the error.</p>"
1225+
}
1226+
},
1227+
"documentation":"<p>Contains an error that occurs from a request to disassociate a client device from a core device. The <a href=\"https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html\">BatchDisassociateClientDeviceWithCoreDevice</a> operation returns a list of these errors.</p>"
1228+
},
1229+
"DisassociateClientDeviceFromCoreDeviceErrorList":{
1230+
"type":"list",
1231+
"member":{"shape":"DisassociateClientDeviceFromCoreDeviceErrorEntry"},
1232+
"max":100,
1233+
"min":1
1234+
},
10291235
"EffectiveDeployment":{
10301236
"type":"structure",
10311237
"required":[
@@ -1509,6 +1715,11 @@
15091715
},
15101716
"documentation":"<p>Contains information about the timeout configuration for a job.</p>"
15111717
},
1718+
"IoTThingName":{
1719+
"type":"string",
1720+
"max":128,
1721+
"min":1
1722+
},
15121723
"IsLatestForTarget":{"type":"boolean"},
15131724
"IsRoot":{"type":"boolean"},
15141725
"LambdaContainerParams":{
@@ -1760,6 +1971,46 @@
17601971
"max":1000,
17611972
"min":1
17621973
},
1974+
"ListClientDevicesAssociatedWithCoreDeviceRequest":{
1975+
"type":"structure",
1976+
"required":["coreDeviceThingName"],
1977+
"members":{
1978+
"coreDeviceThingName":{
1979+
"shape":"IoTThingName",
1980+
"documentation":"<p>The name of the core device. This is also the name of the AWS IoT thing.</p>",
1981+
"location":"uri",
1982+
"locationName":"coreDeviceThingName"
1983+
},
1984+
"maxResults":{
1985+
"shape":"DefaultMaxResults",
1986+
"documentation":"<p>The maximum number of results to be returned per paginated request.</p>",
1987+
"box":true,
1988+
"location":"querystring",
1989+
"locationName":"maxResults"
1990+
},
1991+
"nextToken":{
1992+
"shape":"NextTokenString",
1993+
"documentation":"<p>The token to be used for the next set of paginated results.</p>",
1994+
"box":true,
1995+
"location":"querystring",
1996+
"locationName":"nextToken"
1997+
}
1998+
}
1999+
},
2000+
"ListClientDevicesAssociatedWithCoreDeviceResponse":{
2001+
"type":"structure",
2002+
"members":{
2003+
"associatedClientDevices":{
2004+
"shape":"AssociatedClientDeviceList",
2005+
"documentation":"<p>A list that describes the client devices that are associated with the core device.</p>"
2006+
},
2007+
"nextToken":{
2008+
"shape":"NextTokenString",
2009+
"documentation":"<p>The token for the next set of results, or null if there are no additional results.</p>",
2010+
"box":true
2011+
}
2012+
}
2013+
},
17632014
"ListComponentVersionsRequest":{
17642015
"type":"structure",
17652016
"required":["arn"],

0 commit comments

Comments
 (0)