AWS Greengrass - API Reference Greengrass API Reference ListDeviceDeﬁnitions 160...

AWS GreengrassAPI Reference

AWS Greengrass API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored byAmazon.

Table of ContentsGreengrass API ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1AssociateRoleToGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3AssociateServiceRoleToAccount .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6CreateCoreDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8CreateCoreDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12CreateDeployment .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15CreateDeviceDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18CreateDeviceDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22CreateFunctionDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25CreateFunctionDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31CreateGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36CreateGroupCertificateAuthority ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40CreateGroupVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42CreateLoggerDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46CreateLoggerDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49CreateResourceDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53CreateResourceDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59CreateSoftwareUpdateJob .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65CreateSubscriptionDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69CreateSubscriptionDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72DeleteCoreDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76DeleteDeviceDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77DeleteFunctionDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79DeleteGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81DeleteLoggerDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82DeleteResourceDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84DeleteSubscriptionDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86DisassociateRoleFromGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88DisassociateServiceRoleFromAccount .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90GetAssociatedRole .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92GetConnectivityInfo .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94GetCoreDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98GetCoreDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100GetDeploymentStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103GetDeviceDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106GetDeviceDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108GetFunctionDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111GetFunctionDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114GetGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118GetGroupCertificateAuthority ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121GetGroupCertificateConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124GetGroupVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127GetLoggerDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130GetLoggerDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132GetResourceDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135GetResourceDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138GetServiceRoleForAccount .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143GetSubscriptionDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144GetSubscriptionDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147ListCoreDefinitionVersions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150ListCoreDefinitions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153ListDeployments .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155ListDeviceDefinitionVersions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

ListDeviceDefinitions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160ListFunctionDefinitionVersions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162ListFunctionDefinitions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165ListGroupCertificateAuthorities ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167ListGroupVersions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170ListGroups .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173ListLoggerDefinitionVersions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175ListLoggerDefinitions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178ListResourceDefinitionVersions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180ListResourceDefinitions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182ListSubscriptionDefinitionVersions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184ListSubscriptionDefinitions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187ResetDeployments .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189UpdateConnectivityInfo .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192UpdateCoreDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195UpdateDeviceDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197UpdateFunctionDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199UpdateGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201UpdateGroupCertificateConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203UpdateLoggerDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207UpdateResourceDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209UpdateSubscriptionDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

Endpoints ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213/greengrass/definition/cores .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214/greengrass/definition/cores/CoreDefinitionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220/greengrass/definition/cores/CoreDefinitionId/versions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226/greengrass/definition/cores/CoreDefinitionId/versions/CoreDefinitionVersionId .... . . . . . . . . . . . . . . . . 232/greengrass/definition/devices .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235/greengrass/definition/devices/DeviceDefinitionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241/greengrass/definition/devices/DeviceDefinitionId/versions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247/greengrass/definition/devices/DeviceDefinitionId/versions/DeviceDefinitionVersionId .... . . . . . . . . 254/greengrass/definition/functions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257/greengrass/definition/functions/FunctionDefinitionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265/greengrass/definition/functions/FunctionDefinitionId/versions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271/greengrass/definition/functions/FunctionDefinitionId/versions/FunctionDefinitionVersionId ... 279/greengrass/definition/loggers .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284/greengrass/definition/loggers/LoggerDefinitionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290/greengrass/definition/loggers/LoggerDefinitionId/versions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296/greengrass/definition/loggers/LoggerDefinitionId/versions/LoggerDefinitionVersionId .... . . . . . . . 303/greengrass/definition/resources .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306/greengrass/definition/resources/ResourceDefinitionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314/greengrass/definition/resources/ResourceDefinitionId/versions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320/greengrass/definition/resources/ResourceDefinitionId/versions/ResourceDefinitionVersionId .. 329/greengrass/definition/subscriptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334/greengrass/definition/subscriptions/SubscriptionDefinitionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340/greengrass/definition/subscriptions/SubscriptionDefinitionId/versions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346/greengrass/definition/subscriptions/SubscriptionDefinitionId/versions/SubscriptionDefinitionVersionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353/greengrass/groups .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356/greengrass/groups/GroupId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362/greengrass/groups/GroupId/certificateauthorities ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368/greengrass/groups/GroupId/certificateauthorities/configuration/expiry .... . . . . . . . . . . . . . . . . . . . . . . . . . . . 374/greengrass/groups/GroupId/certificateauthorities/CertificateAuthorityId .... . . . . . . . . . . . . . . . . . . . . . . . . . . 380/greengrass/groups/GroupId/deployments .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383/greengrass/groups/GroupId/deployments/$reset ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389/greengrass/groups/GroupId/deployments/DeploymentId/status .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391/greengrass/groups/GroupId/role .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

/greengrass/groups/GroupId/versions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403/greengrass/groups/GroupId/versions/GroupVersionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409/greengrass/servicerole .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412/greengrass/things/ThingName/connectivityInfo .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418/greengrass/updates .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429AssociateRoleToGroupRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430AssociateServiceRoleToAccountRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431CertificateAuthorityId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431CoreDefinitionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431CoreDefinitionVersionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432CreateCoreDefinitionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432CreateCoreDefinitionVersionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432CreateDeploymentRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433CreateDeviceDefinitionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434CreateDeviceDefinitionVersionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435CreateFunctionDefinitionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436CreateFunctionDefinitionVersionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437CreateGroupRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439CreateGroupVersionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440CreateLoggerDefinitionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441CreateLoggerDefinitionVersionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441CreateResourceDefinitionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442CreateResourceDefinitionVersionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443CreateSoftwareUpdateJobRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446CreateSubscriptionDefinitionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447CreateSubscriptionDefinitionVersionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448DeploymentId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449DeviceDefinitionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449DeviceDefinitionVersionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450FunctionDefinitionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450FunctionDefinitionVersionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450GroupId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450GroupVersionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451LoggerDefinitionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451LoggerDefinitionVersionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451MaxResults ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452NextToken .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452ResetDeploymentsRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452ResourceDefinitionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453ResourceDefinitionVersionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453SubscriptionDefinitionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453SubscriptionDefinitionVersionId .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454ThingName .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454UpdateConnectivityInfoRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454UpdateDefinitionRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455UpdateGroupCertificateConfigurationRequestBody .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456X-Amzn-Client-Token .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

Definitions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456AssociateRoleToGroupRequest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458AssociateServiceRoleToAccountRequest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459AssociateServiceRoleToAccountResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459ConnectivityInfo .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459Core .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460CoreDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460CreateDeploymentRequest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461CreateDeploymentResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

CreateGroupCertificateAuthorityResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462CreateSoftwareUpdateJobRequest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463CreateSoftwareUpdateJobResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464DefinitionInformation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464Deployment .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465DeploymentType .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466Deployments .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466Device .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467DeviceDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467DisassociateRoleFromGroupResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468DisassociateServiceRoleFromAccountResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469Empty Schema .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469ErrorDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469ErrorDetails ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470Function .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470FunctionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472FunctionConfigurationEnvironment .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474FunctionDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475GeneralError ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478GetAssociatedRoleResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479GetConnectivityInfoResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479GetCoreDefinitionVersionResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480GetDeploymentStatusResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481GetDeviceDefinitionVersionResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483GetFunctionDefinitionVersionResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484GetGroupCertificateAuthorityResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487GetGroupVersionResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487GetLoggerDefinitionVersionResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489GetResourceDefinitionVersionResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490GetServiceRoleForAccountResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494GetSubscriptionDefinitionVersionResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494Group .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496Group Certificate Authority Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496GroupCertificateConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496GroupInformation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497GroupOwnerSetting .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498GroupVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498IDList ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499ListDefinitionsResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499ListDeploymentsRequest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501ListDeploymentsResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501ListGroupCertificateAuthoritiesResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502ListGroupsResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503ListVersionsResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504LocalDeviceResourceData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505LocalVolumeResourceData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506Logger .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507LoggerComponent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507LoggerDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508LoggerLevel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509LoggerType .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509Permission .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509ResetDeploymentsRequest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509ResetDeploymentsResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510Resource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510ResourceAccessPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513ResourceDataContainer ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513

ResourceDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515S3MachineLearningModelResourceData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518S3UrlSignerRole .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519SageMakerMachineLearningModelResourceData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519SoftwareToUpdate .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519Subscription .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520SubscriptionDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520UpdateAgentLogLevel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521UpdateConnectivityInfoRequest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521UpdateConnectivityInfoResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522UpdateTargets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523UpdateTargetsArchitecture .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523UpdateTargetsOperatingSystem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523VersionInformation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523Versions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524updateGroupCertificateConfigurationRequest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525

AWS Greengrass API ReferenceActions

Greengrass APIAWS Greengrass provides a resource-based API that uses Hypertext Application Language (HAL). HALprovides a standard way for expressing the resources and relationships of an API as hyperlinks. UsingHAL, you use HTTP methods (GET, PUT, POST, DELETE) to submit requests and receive information aboutthe API in the response. Applications can use the information returned to explore the functionality of theAPI. For more information about HAL, see the JSON Hypertext Application Language draft.

To request a HAL response from AWS Greengrass, specify application/hal+json for the accept requestheader.

Contents• Actions (p. 1)• Endpoints (p. 213)• Parameters (p. 429)• Definitions (p. 456)

ActionsThe following actions are supported:

• AssociateRoleToGroup (p. 3)• AssociateServiceRoleToAccount (p. 6)• CreateCoreDefinition (p. 8)• CreateCoreDefinitionVersion (p. 12)• CreateDeployment (p. 15)• CreateDeviceDefinition (p. 18)• CreateDeviceDefinitionVersion (p. 22)• CreateFunctionDefinition (p. 25)• CreateFunctionDefinitionVersion (p. 31)• CreateGroup (p. 36)• CreateGroupCertificateAuthority (p. 40)• CreateGroupVersion (p. 42)• CreateLoggerDefinition (p. 46)• CreateLoggerDefinitionVersion (p. 49)• CreateResourceDefinition (p. 53)• CreateResourceDefinitionVersion (p. 59)• CreateSoftwareUpdateJob (p. 65)• CreateSubscriptionDefinition (p. 69)• CreateSubscriptionDefinitionVersion (p. 72)• DeleteCoreDefinition (p. 76)• DeleteDeviceDefinition (p. 77)• DeleteFunctionDefinition (p. 79)• DeleteGroup (p. 81)• DeleteLoggerDefinition (p. 82)• DeleteResourceDefinition (p. 84)

AWS Greengrass API ReferenceActions

• DeleteSubscriptionDefinition (p. 86)• DisassociateRoleFromGroup (p. 88)• DisassociateServiceRoleFromAccount (p. 90)• GetAssociatedRole (p. 92)• GetConnectivityInfo (p. 94)• GetCoreDefinition (p. 98)• GetCoreDefinitionVersion (p. 100)• GetDeploymentStatus (p. 103)• GetDeviceDefinition (p. 106)• GetDeviceDefinitionVersion (p. 108)• GetFunctionDefinition (p. 111)• GetFunctionDefinitionVersion (p. 114)• GetGroup (p. 118)• GetGroupCertificateAuthority (p. 121)• GetGroupCertificateConfiguration (p. 124)• GetGroupVersion (p. 127)• GetLoggerDefinition (p. 130)• GetLoggerDefinitionVersion (p. 132)• GetResourceDefinition (p. 135)• GetResourceDefinitionVersion (p. 138)• GetServiceRoleForAccount (p. 143)• GetSubscriptionDefinition (p. 144)• GetSubscriptionDefinitionVersion (p. 147)• ListCoreDefinitionVersions (p. 150)• ListCoreDefinitions (p. 153)• ListDeployments (p. 155)• ListDeviceDefinitionVersions (p. 157)• ListDeviceDefinitions (p. 160)• ListFunctionDefinitionVersions (p. 162)• ListFunctionDefinitions (p. 165)• ListGroupCertificateAuthorities (p. 167)• ListGroupVersions (p. 170)• ListGroups (p. 173)• ListLoggerDefinitionVersions (p. 175)• ListLoggerDefinitions (p. 178)• ListResourceDefinitionVersions (p. 180)• ListResourceDefinitions (p. 182)• ListSubscriptionDefinitionVersions (p. 184)• ListSubscriptionDefinitions (p. 187)• ResetDeployments (p. 189)• UpdateConnectivityInfo (p. 192)• UpdateCoreDefinition (p. 195)• UpdateDeviceDefinition (p. 197)• UpdateFunctionDefinition (p. 199)• UpdateGroup (p. 201)• UpdateGroupCertificateConfiguration (p. 203)

AWS Greengrass API ReferenceAssociateRoleToGroup

• UpdateLoggerDefinition (p. 207)• UpdateResourceDefinition (p. 209)• UpdateSubscriptionDefinition (p. 211)

AssociateRoleToGroupAssociates a role with a group. Your AWS Greengrass core will use the role to access AWS cloud services.The role's permissions should allow Greengrass core Lambda functions to perform actions against thecloud.

URI: PUT /greengrass/groups/GroupId/role

aws greengrass associate-role-to-group \ --group-id <value> \ [--role-arn <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "GroupId": "string", "RoleArn": "string"}

Parameters:GroupId (p. 450)

The ID of the AWS Greengrass group.

where used: path; required: true

type: stringAssociateRoleToGroupRequestBody (p. 430)

where used: body; required: true

{ "RoleArn": "string"}

schema:AssociateRoleToGroupRequest

type: object

required: ["RoleArn"]RoleArn

The ARN of the role you wish to associate with this group.

type: string

Responses:200

success

AssociateRoleToGroupResponse (p. 496)

{ "AssociatedAt": "string"}

type: objectAssociatedAt

The time, in milliseconds since the epoch, when the role ARN was associated with the group.

type: string400

invalid request

GeneralError (p. 478)

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}

GeneralError

General error information.

type: object

required: ["Message"]Message

A message containing information about the error.

type: stringErrorDetails

A list of error details.

type: array

items: ErrorDetail (p. 469)ErrorDetail

Details about the error.

type: objectDetailedErrorCode

A detailed error code.

type: stringDetailedErrorMessage

A detailed error message.

type: string500

server error

GeneralError

type: object

type: array

AWS Greengrass API ReferenceAssociateServiceRoleToAccount

type: string

AssociateServiceRoleToAccountAssociates a role with your account. AWS Greengrass will use the role to access your Lambda functionsand AWS IoT resources. This is necessary for deployments to succeed. The role must have at leastminimum permissions in the policy AWSGreengrassResourceAccessRolePolicy.

URI: PUT /greengrass/servicerole

aws greengrass associate-service-role-to-account \ [--role-arn <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Parameters:AssociateServiceRoleToAccountRequestBody (p. 431)

schema:AssociateServiceRoleToAccountRequest

type: object

The ARN of the service role you wish to associate with your account.

type: string

Responses:200

success

AssociateServiceRoleToAccountResponse (p. 459)

AWS Greengrass API ReferenceAssociateServiceRoleToAccount

"AssociatedAt": "string"}

AssociateServiceRoleToAccountResponse

The time when the service role was associated with the account.

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceCreateCoreDefinition

type: string500

server error

GeneralError

type: object

type: array

type: string

CreateCoreDefinitionCreates a core definition. You may provide the initial version of the core definition now or useCreateCoreDefinitionVersion at a later time. AWS Greengrass groups must each contain exactlyone AWS Greengrass core.

URI: POST /greengrass/definition/cores

Produces: application/json

aws greengrass create-core-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ] }, "AmznClientToken": "string"}

Parameters:CreateCoreDefinitionRequestBody (p. 432)

Information needed to create a core definition.

{ "Name": "string", "InitialVersion": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}

schema:Name

The name of the core definition.

type: stringInitialVersion

Information about a core definition version.

type: objectCores

A list of cores in the core definition version.

type: array

items: Core (p. 460)Core

Information about a core.

type: object

required: ["Id", "ThingArn", "CertificateArn"]Id

A descriptive or arbitrary ID for the core. This value must be unique within the core definitionversion. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.

type: stringThingArn

The ARN of the thing which is the core.

type: stringCertificateArn

The ARN of the certificate associated with the core.

type: stringSyncShadow

If true, the core's local shadow is automatically synced with the cloud.

type: booleanX-Amzn-Client-Token (p. 456)

A client token used to correlate requests and responses.

where used: header; required: false

type: string

Responses:200 (CreateCoreDefinitionResponse)

DefinitionInformation (p. 464)

{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string",

"LatestVersionArn": "string"}

DefinitionInformation

Information about a definition.

type: objectName

The name of the definition.

type: stringId

The ID of the definition.

type: stringArn

The ARN of the definition.

type: stringLastUpdatedTimestamp

The time, in milliseconds since the epoch, when the definition was last updated.

type: stringCreationTimestamp

The time, in milliseconds since the epoch, when the definition was created.

type: stringLatestVersion

The latest version of the definition.

type: stringLatestVersionArn

The ARN of the latest version of the definition.

type: string400

invalid request

AWS Greengrass API ReferenceCreateCoreDefinitionVersion

GeneralError

type: object

type: array

type: string

CreateCoreDefinitionVersionCreates a version of a core definition that has already been defined. AWS Greengrass groups must eachcontain exactly one AWS Greengrass core.

URI: POST /greengrass/definition/cores/CoreDefinitionId/versions

aws greengrass create-core-definition-version \ --core-definition-id <value> \ [--cores <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "CoreDefinitionId": "string",

"Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ], "AmznClientToken": "string"}

Parameters:CoreDefinitionId (p. 431)

The ID of the core definition.

type: stringCreateCoreDefinitionVersionRequestBody (p. 432)

{ "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}

schema:CoreDefinitionVersion

type: objectCores

type: array

type: object

type: string

Responses:200 (CreateCoreDefinitionVersionResponse)

VersionInformation (p. 523)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string"}

VersionInformation

Information about a version.

type: objectArn

The ARN of the version.

type: stringId

The ID of the version.

type: stringVersion

The unique ID of the version.

type: string

AWS Greengrass API ReferenceCreateDeployment

CreationTimestamp

The time, in milliseconds since the epoch, when the version was created.

type: string400

invalid request

GeneralError

type: object

type: array

type: string

CreateDeploymentCreates a deployment.

URI: POST /greengrass/groups/GroupId/deployments

aws greengrass create-deployment \ --group-id <value> \ [--deployment-type <value>] \ [--deployment-id <value>] \ [--group-version-id <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string", "AmznClientToken": "string"}

type: stringCreateDeploymentRequestBody (p. 433)

{ "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string"}

schema:CreateDeploymentRequest

Information about a deployment.

type: object

required: ["DeploymentType"]DeploymentType

type: string

enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]

DeploymentId

The ID of the deployment if you wish to redeploy a previous deployment.

type: stringGroupVersionId

The ID of the group version to be deployed.

type: stringX-Amzn-Client-Token (p. 456)

type: string

Responses:200

Success. The group was deployed.

CreateDeploymentResponse (p. 462)

{ "DeploymentArn": "string", "DeploymentId": "string"}

CreateDeploymentResponse

type: objectDeploymentArn

The ARN of the deployment.

type: stringDeploymentId

The ID of the deployment.

type: string400

invalid request

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]

AWS Greengrass API ReferenceCreateDeviceDefinition

GeneralError

type: object

type: array

type: string

CreateDeviceDefinitionCreates a device definition. You may provide the initial version of the device definition now or useCreateDeviceDefinitionVersion at a later time.

URI: POST /greengrass/definition/devices

aws greengrass create-device-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ] }, "AmznClientToken": "string"}

Parameters:CreateDeviceDefinitionRequestBody (p. 434)

Information needed to create a device definition.

{ "Name": "string", "InitialVersion": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}

schema:Name

The name of the device definition.

Information about a device definition version.

type: objectDevices

A list of devices in the definition version.

type: array

items: Device (p. 467)Device

Information about a device.

type: object

A descriptive or arbitrary ID for the device. This value must be unique within the devicedefinition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.

The thing ARN of the device.

The ARN of the certificate associated with the device.

If true, the device's local shadow will be automatically synced with the cloud.

type: string

Responses:200 (CreateDeviceDefinitionResponse)

{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string"}

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceCreateDeviceDefinitionVersion

type: string

CreateDeviceDefinitionVersionCreates a version of a device definition that has already been defined.

URI: POST /greengrass/definition/devices/DeviceDefinitionId/versions

aws greengrass create-device-definition-version \ --device-definition-id <value> \ [--devices <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "DeviceDefinitionId": "string", "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ], "AmznClientToken": "string"}

Parameters:DeviceDefinitionId (p. 449)

The ID of the device definition.

type: string

CreateDeviceDefinitionVersionRequestBody (p. 435)

{ "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}

schema:

DeviceDefinitionVersion

type: object

Devices

type: array

items: Device (p. 467)

Device

type: object

required: ["Id", "ThingArn", "CertificateArn"]

type: string

ThingArn

type: string

CertificateArn

type: string

SyncShadow

type: boolean

X-Amzn-Client-Token (p. 456)

type: string

Responses:200 (CreateDeviceDefinitionVersionResponse)

VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string"

AWS Greengrass API ReferenceCreateFunctionDefinition

GeneralError

type: object

type: array

type: string

CreateFunctionDefinitionCreates a Lambda function definition which contains a list of Lambda functions and their configurationsto be used in a group. You can create an initial version of the definition by providing a list of Lambdafunctions and their configurations now, or use CreateFunctionDefinitionVersion later.

URI: POST /greengrass/definition/functions

aws greengrass create-function-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": "boolean", "Executable": "string", "ExecArgs": "string", "MemorySize": "integer", "Timeout": "integer", "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": "boolean" } } } ] }, "AmznClientToken": "string"}

Parameters:CreateFunctionDefinitionRequestBody (p. 436)

{ "Name": "string", "InitialVersion": { "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0, "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" },

"ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ] }}

schema:Name

The name of the function definition.

Information about a function definition version.

type: objectFunctions

A list of Lambda functions in this function definition version.

type: array

items: Function (p. 470)

Information about a Lambda function.

type: object

required: ["Id"]Id

A descriptive or arbitrary ID for the function. This value must be unique within the functiondefinition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.

type: stringFunctionArn

The ARN of the Lambda function.

type: stringFunctionConfiguration

The configuration of the Lambda function.

type: objectPinned

True if the function is pinned. Pinned means the function is long-lived and starts when the corestarts.

type: boolean

Executable

The name of the function executable.

type: stringExecArgs

The execution arguments.

type: stringMemorySize

The memory size, in KB, which the function requires.

type: integerTimeout

The allowed function execution time, after which Lambda should terminate the function. Thistimeout still applies to pinned lambdas for each request.

type: integerEncodingType

The expected encoding type of the input payload for the function. The default is json.

type: string

enum: ["binary", "json"]Environment

The environment configuration of the function.

type: objectVariables

Environment variables for the Lambda function's configuration.

type: object

additionalProperties: "type"=>"string"ResourceAccessPolicies

A list of the resources, with their permissions, to which the Lambda function will be grantedaccess. A Lambda function can have at most 10 resources.

type: array

items: ResourceAccessPolicy (p. 513)ResourceAccessPolicy

A policy used by the function to access a resource.

type: object

required: ["ResourceId"]ResourceId

The ID of the resource. (This ID is assigned to the resource when you create the resourcedefiniton.)

type: stringPermission

The type of permission a function has to access a resource.

type: string

enum: ["ro", "rw"]AccessSysfs

If true, the Lambda function is allowed to access the host's /sys folder. Use this when theLambda function needs to read device information from /sys.

type: string

Responses:200 (CreateFunctionDefinitionResponse)

type: objectName

type: stringId

type: stringArn

type: string

LastUpdatedTimestamp

type: string400

invalid request

GeneralError

type: object

type: array

type: object

AWS Greengrass API ReferenceCreateFunctionDefinitionVersion

DetailedErrorCode

type: string

CreateFunctionDefinitionVersionCreates a version of a Lambda function definition that has already been defined.

URI: POST /greengrass/definition/functions/FunctionDefinitionId/versions

aws greengrass create-function-definition-version \ --function-definition-id <value> \ [--functions <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "FunctionDefinitionId": "string", "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": "boolean", "Executable": "string", "ExecArgs": "string", "MemorySize": "integer", "Timeout": "integer", "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": "boolean" } } } ],

"AmznClientToken": "string"}

Parameters:FunctionDefinitionId (p. 450)

The ID of the Lambda function definition.

type: stringCreateFunctionDefinitionVersionRequestBody (p. 437)

Information about the function definition version.

{ "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0, "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ]}

schema:FunctionDefinitionVersion

type: array

type: object

required: ["Id"]Id

type: objectPinned

type: booleanExecutable

type: string

enum: ["binary", "json"]

Environment

type: object

type: array

type: object

type: string

Responses:200 (CreateFunctionDefinitionVersionResponse)

VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: string

AWS Greengrass API ReferenceCreateGroup

ErrorDetails

type: array

type: string

CreateGroupCreates a group. You may provide the initial version of the group or use CreateGroupVersion at a latertime.

TipYou can use the gg_group_setup package (from GitHub) as a library or command-lineapplication to create and deploy AWS Greengrass groups.

URI: POST /greengrass/groups

aws greengrass create-group \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string" }, "AmznClientToken": "string"

Parameters:CreateGroupRequestBody (p. 439)

{ "Name": "string", "InitialVersion": { "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string" }}

schema:Name

The name of the group.

Information about a group version.

type: objectCoreDefinitionVersionArn

The ARN of the core definition version for this group.

type: stringDeviceDefinitionVersionArn

The ARN of the device definition version for this group.

type: stringFunctionDefinitionVersionArn

The ARN of the function definition version for this group.

type: stringSubscriptionDefinitionVersionArn

The ARN of the subscription definition version for this group.

type: stringLoggerDefinitionVersionArn

The ARN of the logger definition version for this group.

type: stringResourceDefinitionVersionArn

The resource definition version ARN for this group.

type: string

Responses:200 (CreateGroupResponse)

Success. The group was created.

type: objectName

type: stringId

type: stringArn

type: string

LatestVersion

type: string400

invalid request

GeneralError

type: object

type: array

type: string

AWS Greengrass API ReferenceCreateGroupCertificateAuthority

CreateGroupCertificateAuthorityCreates a CA for the group. If a CA already exists, it will rotate the existing CA.

URI: POST /greengrass/groups/GroupId/certificateauthorities

aws greengrass create-group-certificate-authority \ --group-id <value> \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "AmznClientToken": "string"}

type: string

Responses:200

Success. The response body contains the new active CA ARN.

CreateGroupCertificateAuthorityResponse (p. 462)

{ "GroupCertificateAuthorityArn": "string"}

CreateGroupCertificateAuthorityResponse

type: object

AWS Greengrass API ReferenceCreateGroupCertificateAuthority

GroupCertificateAuthorityArn

The ARN of the group certificate authority.

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

AWS Greengrass API ReferenceCreateGroupVersion

GeneralError

type: object

type: array

type: string

CreateGroupVersionCreates a version of a group which has already been defined.

URI: POST /greengrass/groups/GroupId/versions

aws greengrass create-group-version \ --group-id <value> \

[--core-definition-version-arn <value>] \ [--device-definition-version-arn <value>] \ [--function-definition-version-arn <value>] \ [--subscription-definition-version-arn <value>] \ [--logger-definition-version-arn <value>] \ [--resource-definition-version-arn <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string", "AmznClientToken": "string"}

type: stringCreateGroupVersionRequestBody (p. 440)

{ "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string"}

schema:GroupVersion

type: string

Responses:200 (CreateGroupVersionResponse)

Success. The response contains information about the group version.

VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceCreateLoggerDefinition

type: string

CreateLoggerDefinitionCreates a logger definition. You may provide the initial version of the logger definition now or useCreateLoggerDefinitionVersion at a later time.

URI: POST /greengrass/definition/loggers

aws greengrass create-logger-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": "integer" } ] }, "AmznClientToken": "string"}

Parameters:CreateLoggerDefinitionRequestBody (p. 441)

{ "Name": "string", "InitialVersion": { "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ] }}

schema:Name

The name of the logger definition.

Information about a logger definition version.

type: objectLoggers

A list of loggers.

type: array

items: Logger (p. 507)Logger

Information about a logger

type: object

required: ["Id", "Type", "Component", "Level"]Id

A descriptive or arbitrary ID for the logger. This value must be unique within the loggerdefinition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.

type: stringType

type: string

enum: ["FileSystem", "AWSCloudWatch"]Component

type: string

enum: ["GreengrassSystem", "Lambda"]Level

type: string

enum: ["DEBUG", "INFO", "WARN", "ERROR", "FATAL"]Space

The amount of file space, in KB, to use if the local file system is used for logging purposes.

type: integerX-Amzn-Client-Token (p. 456)

type: string

Responses:200 (CreateLoggerDefinitionResponse)

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

AWS Greengrass API ReferenceCreateLoggerDefinitionVersion

GeneralError

type: object

type: array

type: string

CreateLoggerDefinitionVersionCreates a version of a logger definition that has already been defined.

URI: POST /greengrass/definition/loggers/LoggerDefinitionId/versions

aws greengrass create-logger-definition-version \

--logger-definition-id <value> \ [--loggers <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "LoggerDefinitionId": "string", "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": "integer" } ], "AmznClientToken": "string"}

Parameters:LoggerDefinitionId (p. 451)

The ID of the logger definition.

type: stringCreateLoggerDefinitionVersionRequestBody (p. 441)

{ "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ]}

schema:LoggerDefinitionVersion

type: objectLoggers

A list of loggers.

type: array

items: Logger (p. 507)

Logger

type: object

type: stringType

type: string

type: integerX-Amzn-Client-Token (p. 456)

type: string

Responses:200 (CreateLoggerDefinitionVersionResponse)

VersionInformation

type: object

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: array

type: object

AWS Greengrass API ReferenceCreateResourceDefinition

DetailedErrorCode

type: string

CreateResourceDefinitionCreates a resource definition which contains a list of resources to be used in a group. Youcan create an initial version of the definition by providing a list of resources now, or useCreateResourceDefinitionVersion later.

URI: POST /greengrass/definition/resources

aws greengrass create-resource-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": "boolean", "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": "boolean", "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string"

}, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ] }, "AmznClientToken": "string"}

Parameters:CreateResourceDefinitionRequestBody (p. 442)

{ "Name": "string", "InitialVersion": { "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ] }}

schema:Name

The name of the resource definition.

type: string

InitialVersion

Information about a resource definition version.

type: objectResources

A list of resources.

type: array

items: Resource (p. 510)Resource

Information about a resource.

type: object

required: ["Id", "Name", "ResourceDataContainer"]Id

The resource ID, used to refer to a resource in the Lambda function configuration. Max lengthis 128 characters with pattern [a‑zA‑Z0‑9:_‑]+. This must be unique within a Greengrassgroup.

type: stringName

The descriptive resource name, which is displayed on the AWS Greengrass console. Max length128 characters with pattern [a‑zA‑Z0‑9:_‑]+. This must be unique within a Greengrassgroup.

type: stringResourceDataContainer

A container for resource data. The container takes only one of thefollowing supported resource data types: LocalDeviceResourceData,LocalVolumeResourceData, SageMakerMachineLearningModelResourceData,S3MachineLearningModelResourceData.

type: object

NOTE: oneOfLocalDeviceResourceData

Attributes that define a local device resource.

type: objectSourcePath

The local absolute path of the device resource. The source path for a device resource can referonly to a character device or block device under /dev.

type: stringGroupOwnerSetting

Group owner related settings for local resources.

type: object

AutoAddGroupOwner

If true, AWS Greengrass automatically adds the specified Linux OS group owner of the resourceto the Lambda process privileges. Thus the Lambda process will have the file access permissionsof the added Linux group.

type: booleanGroupOwner

The name of the Linux OS group whose privileges will be added to the Lambda process. Thisfield is optional.

type: stringLocalVolumeResourceData

Attributes that define a local volume resource.

The local absolute path of the volume resource on the host. The source path for a volumeresource type cannot start with /proc or /sys.

type: stringDestinationPath

The absolute local path of the resource inside the Lambda environment.

type: objectAutoAddGroupOwner

type: stringSageMakerMachineLearningModelResourceData

Attributes that define an Amazon SageMaker machine learning resource.

type: objectSageMakerJobArn

The ARN of the Amazon SageMaker training job that represents the source model.

type: string

DestinationPath

type: stringS3MachineLearningModelResourceData

Attributes that define an Amazon S3 machine learning resource.

type: objectS3Uri

The URI of the source model in an Amazon S3 bucket. The model package must be in tar.gzor .zip format.

type: string

Responses:200 (CreateResourceDefinitionResponse)

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceCreateResourceDefinitionVersion

type: string

CreateResourceDefinitionVersionCreates a version of a resource definition that has already been defined.

URI: POST /greengrass/definition/resources/ResourceDefinitionId/versions

aws greengrass create-resource-definition-version \ --resource-definition-id <value> \ [--resources <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ResourceDefinitionId": "string", "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": "boolean", "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": "boolean", "GroupOwner": "string" }

}, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ], "AmznClientToken": "string"}

Parameters:ResourceDefinitionId (p. 453)

The ID of the resource definition.

type: stringCreateResourceDefinitionVersionRequestBody (p. 443)

Information about the resource definition version.

{ "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ]

schema:ResourceDefinitionVersion

type: array

type: object

type: stringName

type: object

type: string

GroupOwnerSetting

type: objectS3Uri

type: string

Responses:200 (CreateResourceDefinitionVersionResponse)

VersionInformation

type: objectArn

type: stringId

type: string

Version

type: string400

invalid request

GeneralError

type: object

type: array

type: string

AWS Greengrass API ReferenceCreateSoftwareUpdateJob

CreateSoftwareUpdateJobCreates a software update for a core or group of cores (specified as an IoT thing group.) Use this toupdate the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs featurewhich provides additional commands to manage a Greengrass core software update job.

URI: POST /greengrass/updates

aws greengrass create-software-update-job \ [--update-targets-architecture <value>] \ [--update-targets <value>] \ [--software-to-update <value>] \ [--s3-url-signer-role <value>] \ [--update-agent-log-level <value>] \ [--update-targets-operating-system <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "UpdateTargetsArchitecture": "armv7l|x86_64|aarch64", "UpdateTargets": [ "string" ], "SoftwareToUpdate": "core|ota_agent", "S3UrlSignerRole": "string", "UpdateAgentLogLevel": "NONE|TRACE|DEBUG|VERBOSE|INFO|WARN|ERROR|FATAL", "UpdateTargetsOperatingSystem": "ubuntu|raspbian|amazon_linux", "AmznClientToken": "string"}

Parameters:CreateSoftwareUpdateJobRequestBody (p. 446)

{ "UpdateTargetsArchitecture": "armv7l|x86_64|aarch64", "UpdateTargets": [ "string" ], "SoftwareToUpdate": "core|ota_agent", "S3UrlSignerRole": "string", "UpdateAgentLogLevel": "NONE|TRACE|DEBUG|VERBOSE|INFO|WARN|ERROR|FATAL", "UpdateTargetsOperatingSystem": "ubuntu|raspbian|amazon_linux"}

schema:CreateSoftwareUpdateJobRequest

Request for the CreateSoftwareUpdateJob API.

type: object

required: ["UpdateTargetsArchitecture", "UpdateTargets", "SoftwareToUpdate","S3UrlSignerRole", "UpdateTargetsOperatingSystem"]

UpdateTargetsArchitecture

The architecture of the cores which are the targets of an update.

type: string

enum: ["armv7l", "x86_64", "aarch64"]UpdateTargets

The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.

type: arraySoftwareToUpdate

The piece of software on the Greengrass core that will be updated.

type: string

enum: ["core", "ota_agent"]S3UrlSignerRole

The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the updateartifact.

type: stringUpdateAgentLogLevel

The minimum level of log statements that should be logged by the OTA Agent during anupdate.

type: string

enum: ["NONE", "TRACE", "DEBUG", "VERBOSE", "INFO", "WARN", "ERROR", "FATAL"]UpdateTargetsOperatingSystem

The operating system of the cores which are the targets of an update.

type: string

enum: ["ubuntu", "raspbian", "amazon_linux"]X-Amzn-Client-Token (p. 456)

type: string

Responses:200

success

CreateSoftwareUpdateJobResponse (p. 464)

{ "IotJobId": "string", "IotJobArn": "string"}

CreateSoftwareUpdateJobResponse

type: objectIotJobId

The IoT Job Id corresponding to this update.

type: stringIotJobArn

The IoT Job ARN corresponding to this update.

type: string400

invalid request

GeneralError

type: object

type: array

type: object

DetailedErrorCode

type: string500

server error

GeneralError

type: object

type: array

type: string

AWS Greengrass API ReferenceCreateSubscriptionDefinition

CreateSubscriptionDefinitionCreates a subscription definition. You may provide the initial version of the subscription definition now oruse CreateSubscriptionDefinitionVersion at a later time.

URI: POST /greengrass/definition/subscriptions

aws greengrass create-subscription-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }, "AmznClientToken": "string"}

Parameters:CreateSubscriptionDefinitionRequestBody (p. 447)

{ "Name": "string", "InitialVersion": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }}

schema:Name

The name of the subscription definition.

Information about a subscription definition version.

type: objectSubscriptions

A list of subscriptions.

type: array

items: Subscription (p. 520)Subscription

Information about a subscription.

type: object

required: ["Id", "Source", "Subject", "Target"]Id

A descriptive or arbitrary ID for the subscription. This value must be unique within thesubscription definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.

type: stringSource

The source of the subscription. Can be a thing ARN, a Lambda function ARN, 'cloud' (whichrepresents the AWS IoT cloud), or 'GGShadowService'.

type: stringSubject

The subject of the message.

type: stringTarget

Where the message is sent to. Can be a thing ARN, a Lambda function ARN, 'cloud' (whichrepresents the AWS IoT cloud), or 'GGShadowService'.

type: string

Responses:200 (CreateSubscriptionDefinitionResponse)

"Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string"}

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

{ "Message": "string", "ErrorDetails": [ {

AWS Greengrass API ReferenceCreateSubscriptionDefinitionVersion

"DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}

GeneralError

type: object

type: array

type: string

CreateSubscriptionDefinitionVersionCreates a version of a subscription definition which has already been defined.

URI: POST /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions

aws greengrass create-subscription-definition-version \ --subscription-definition-id <value> \ [--subscriptions <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "SubscriptionDefinitionId": "string", "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ], "AmznClientToken": "string"}

Parameters:SubscriptionDefinitionId (p. 453)

The ID of the subscription definition.

type: stringCreateSubscriptionDefinitionVersionRequestBody (p. 448)

{ "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ]}

schema:SubscriptionDefinitionVersion

type: array

type: object

required: ["Id", "Source", "Subject", "Target"]

type: stringSource

type: stringSubject

type: stringTarget

type: string

Responses:200 (CreateSubscriptionDefinitionVersionResponse)

VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceDeleteCoreDefinition

type: string

DeleteCoreDefinitionDeletes a core definition.

URI: DELETE /greengrass/definition/cores/CoreDefinitionId

aws greengrass delete-core-definition \ --core-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "CoreDefinitionId": "string"}

type: string

Responses:200

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

AWS Greengrass API ReferenceDeleteDeviceDefinition

GeneralError

type: object

type: array

type: string

DeleteDeviceDefinitionDeletes a device definition.

URI: DELETE /greengrass/definition/devices/DeviceDefinitionId

aws greengrass delete-device-definition \

AWS Greengrass API ReferenceDeleteDeviceDefinition

--device-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "DeviceDefinitionId": "string"}

type: string

Responses:200

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

AWS Greengrass API ReferenceDeleteFunctionDefinition

type: array

type: string

DeleteFunctionDefinitionDeletes a Lambda function definition.

URI: DELETE /greengrass/definition/functions/FunctionDefinitionId

aws greengrass delete-function-definition \ --function-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "FunctionDefinitionId": "string"}

AWS Greengrass API ReferenceDeleteFunctionDefinition

type: string

Responses:200

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceDeleteGroup

type: string

DeleteGroupDeletes a group.

URI: DELETE /greengrass/groups/GroupId

aws greengrass delete-group \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string"}

type: string

Responses:200

success

Empty (p. 469)

AWS Greengrass API ReferenceDeleteLoggerDefinition

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

type: string

DeleteLoggerDefinitionDeletes a logger definition.

AWS Greengrass API ReferenceDeleteLoggerDefinition

URI: DELETE /greengrass/definition/loggers/LoggerDefinitionId

aws greengrass delete-logger-definition \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "LoggerDefinitionId": "string"}

type: string

Responses:200

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

AWS Greengrass API ReferenceDeleteResourceDefinition

GeneralError

type: object

type: array

type: string

DeleteResourceDefinitionDeletes a resource definition.

URI: DELETE /greengrass/definition/resources/ResourceDefinitionId

aws greengrass delete-resource-definition \ --resource-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ResourceDefinitionId": "string"}

AWS Greengrass API ReferenceDeleteResourceDefinition

type: string

Responses:200

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

AWS Greengrass API ReferenceDeleteSubscriptionDefinition

type: array

type: string

DeleteSubscriptionDefinitionDeletes a subscription definition.

URI: DELETE /greengrass/definition/subscriptions/SubscriptionDefinitionId

aws greengrass delete-subscription-definition \ --subscription-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "SubscriptionDefinitionId": "string"}

type: string

Responses:200

success

AWS Greengrass API ReferenceDeleteSubscriptionDefinition

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

type: string

AWS Greengrass API ReferenceDisassociateRoleFromGroup

DisassociateRoleFromGroupDisassociates the role from a group.

URI: DELETE /greengrass/groups/GroupId/role

aws greengrass disassociate-role-from-group \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

type: string

Responses:200

success

DisassociateRoleFromGroupResponse (p. 468)

{ "DisassociatedAt": "string"}

DisassociateRoleFromGroupResponse

type: objectDisassociatedAt

The time, in milliseconds since the epoch, when the role was disassociated from the group.

type: string400

invalid request

AWS Greengrass API ReferenceDisassociateRoleFromGroup

GeneralError

type: object

type: array

type: string500

server error

AWS Greengrass API ReferenceDisassociateServiceRoleFromAccount

GeneralError

type: object

type: array

type: string

DisassociateServiceRoleFromAccountDisassociates the service role from your account. Without a service role, deployments will not work.

URI: DELETE /greengrass/servicerole

aws greengrass disassociate-service-role-from-account \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses:200

success

DisassociateServiceRoleFromAccountResponse (p. 469)

AWS Greengrass API ReferenceDisassociateServiceRoleFromAccount

"DisassociatedAt": "string"}

DisassociateServiceRoleFromAccountResponse

The time when the service role was disassociated from the account.

type: string500

server error

GeneralError

type: object

type: array

AWS Greengrass API ReferenceGetAssociatedRole

type: string

GetAssociatedRoleRetrieves the role associated with a particular group.

URI: GET /greengrass/groups/GroupId/role

aws greengrass get-associated-role \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

type: string

Responses:200

success

GetAssociatedRoleResponse (p. 479)

{ "AssociatedAt": "string", "RoleArn": "string"}

GetAssociatedRoleResponse

The time when the role was associated with the group.

type: stringRoleArn

The ARN of the role that is associated with the group.

AWS Greengrass API ReferenceGetAssociatedRole

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

{ "Message": "string",

AWS Greengrass API ReferenceGetConnectivityInfo

"ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}

GeneralError

type: object

type: array

type: string

GetConnectivityInfoRetrieves the connectivity information for a core.

URI: GET /greengrass/things/ThingName/connectivityInfo

aws greengrass get-connectivity-info \ --thing-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ThingName": "string"}

Parameters:ThingName (p. 454)

The thing name.

type: string

Responses:200

success

GetConnectivityInfoResponse (p. 479)

{ "message": "string", "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": 0x01, "Metadata": "string" } ]}

Information about a Greengrass core's connectivity.message

A message about the connectivity info request.

type: stringConnectivityInfo

Connectivity info list.

type: array

items: ConnectivityInfo (p. 459)

Information about a Greengrass core's connectivity.

required: ["Id", "HostAddress"]Id

The ID of the connectivity information.

type: stringHostAddress

The endpoint for the Greengrass core. Can be an IP address or DNS.

type: stringPortNumber

The port of the Greengrass core. Usually 8883.

type: integer

format: int32Metadata

Metadata for this endpoint.

type: string400

invalid request

GeneralError

type: object

type: array

type: object

DetailedErrorCode

type: string500

server error

GeneralError

type: object

type: array

type: string

AWS Greengrass API ReferenceGetCoreDefinition

GetCoreDefinitionRetrieves information about a core definition version.

URI: GET /greengrass/definition/cores/CoreDefinitionId

aws greengrass get-core-definition \ --core-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

type: string

Responses:200 (GetCoreDefinitionResponse)

type: objectName

AWS Greengrass API ReferenceGetCoreDefinition

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

type: string

AWS Greengrass API ReferenceGetCoreDefinitionVersion

ErrorDetails

type: array

type: string

GetCoreDefinitionVersionRetrieves information about a core definition version.

URI: GET /greengrass/definition/cores/CoreDefinitionId/versions/CoreDefinitionVersionId

aws greengrass get-core-definition-version \ --core-definition-id <value> \ --core-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "CoreDefinitionId": "string", "CoreDefinitionVersionId": "string"}

type: string

CoreDefinitionVersionId (p. 432)

The ID of the core definition version.

type: string

Responses:200

success

GetCoreDefinitionVersionResponse (p. 480)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}

GetCoreDefinitionVersionResponse

type: objectArn

The ARN of the core definition version.

type: stringId

type: stringVersion

The version of the core definition version.

The time, in milliseconds since the epoch, when the core definition version was created.

type: stringDefinition

type: objectCores

type: array

type: object

type: boolean400

invalid request

GeneralError

type: object

required: ["Message"]

AWS Greengrass API ReferenceGetDeploymentStatus

Message

type: array

type: string

GetDeploymentStatusReturns the status of a deployment.

URI: GET /greengrass/groups/GroupId/deployments/DeploymentId/status

aws greengrass get-deployment-status \ --group-id <value> \ --deployment-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "DeploymentId": "string"}

type: string

DeploymentId (p. 449)

type: string

Responses:200

Success. The response body contains the status of the deployment for the group.

GetDeploymentStatusResponse (p. 481)

{ "DeploymentStatus": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "UpdatedAt": "string", "ErrorMessage": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}

GetDeploymentStatusResponse

Information about the status of a deployment for a group.

type: object

DeploymentStatus

The status of the deployment.

type: string

DeploymentType

type: string

UpdatedAt

The time, in milliseconds since the epoch, when the deployment status was updated.

type: string

ErrorMessage

Error message

type: string

ErrorDetails

type: array

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceGetDeviceDefinition

type: string

GetDeviceDefinitionRetrieves information about a device definition.

URI: GET /greengrass/definition/devices/DeviceDefinitionId

aws greengrass get-device-definition \ --device-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

type: string

Responses:200 (GetDeviceDefinitionResponse)

{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string",

AWS Greengrass API ReferenceGetDeviceDefinition

"LatestVersion": "string", "LatestVersionArn": "string"}

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

AWS Greengrass API ReferenceGetDeviceDefinitionVersion

GeneralError

type: object

type: array

type: string

GetDeviceDefinitionVersionRetrieves information about a device definition version.

URI: GET /greengrass/definition/devices/DeviceDefinitionId/versions/DeviceDefinitionVersionId

aws greengrass get-device-definition-version \ --device-definition-id <value> \ --device-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "DeviceDefinitionId": "string", "DeviceDefinitionVersionId": "string"

type: stringDeviceDefinitionVersionId (p. 450)

The ID of the device definition version.

type: string

Responses:200 (GetDeviceDefinitionVersionResponse)

GetDeviceDefinitionVersionResponse (p. 483)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}

GetDeviceDefinitionVersionResponse

type: objectArn

The ARN of the device definition version.

type: stringId

type: stringVersion

The version of the device definition version.

The time, in milliseconds since the epoch, when the device definition version was created.

type: objectDevices

type: array

type: object

type: boolean400

invalid request

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" }

AWS Greengrass API ReferenceGetFunctionDefinition

GeneralError

type: object

type: array

type: string

GetFunctionDefinitionRetrieves information about a Lambda function definition, including its creation time and latest version.

URI: GET /greengrass/definition/functions/FunctionDefinitionId

aws greengrass get-function-definition \ --function-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "FunctionDefinitionId": "string"

type: string

Responses:200 (GetFunctionDefinitionResponse)

success

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceGetFunctionDefinitionVersion

type: string

GetFunctionDefinitionVersionRetrieves information about a Lambda function definition version, including which Lambda functions areincluded in the version and their configurations.

URI: GET /greengrass/definition/functions/FunctionDefinitionId/versions/FunctionDefinitionVersionId

aws greengrass get-function-definition-version \ --function-definition-id <value> \ --function-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "FunctionDefinitionId": "string", "FunctionDefinitionVersionId": "string"}

type: stringFunctionDefinitionVersionId (p. 450)

The ID of the function definition version.

type: string

Responses:200

success

GetFunctionDefinitionVersionResponse (p. 484)

{ "Arn": "string", "Id": "string",

"Version": "string", "CreationTimestamp": "string", "Definition": { "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0, "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ] }}

GetFunctionDefinitionVersionResponse

type: objectArn

The ARN of the function definition version.

type: stringId

type: stringVersion

The version of the function definition version.

The time, in milliseconds since the epoch, when the function definition version was created.

type: array

type: object

required: ["Id"]Id

type: objectPinned

type: integer

EncodingType

type: string

type: object

type: array

type: object

type: string

type: boolean400

invalid request

AWS Greengrass API ReferenceGetGroup

"Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}

GeneralError

type: object

type: array

type: string

GetGroupRetrieves information about a group.

URI: GET /greengrass/groups/GroupId

aws greengrass get-group \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

type: string

Responses:200 (GetGroupResponse)

success

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceGetGroupCertificateAuthority

type: string

GetGroupCertificateAuthorityRetreives the CA associated with a group. Returns the public key of the CA.

URI: GET /greengrass/groups/GroupId/certificateauthorities/CertificateAuthorityId

aws greengrass get-group-certificate-authority \ --group-id <value> \ --certificate-authority-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "CertificateAuthorityId": "string"}

type: stringCertificateAuthorityId (p. 431)

The ID of the certificate authority.

type: string

Responses:200

Success. The response body contains the PKI Configuration.

GetGroupCertificateAuthorityResponse (p. 487)

{ "PemEncodedCertificate": "string", "GroupCertificateAuthorityArn": "string", "GroupCertificateAuthorityId": "string"}

GetGroupCertificateAuthorityResponse

Information about a certificate authority for a group.

type: object

PemEncodedCertificate

The PEM encoded certificate for the group.

type: string

The ARN of the certificate authority for the group.

type: string

GroupCertificateAuthorityId

The ID of the certificate authority for the group.

type: string

invalid request

GeneralError

type: object

Message

type: string

ErrorDetails

type: array

type: string500

server error

GeneralError

type: object

type: array

type: object

AWS Greengrass API ReferenceGetGroupCertificateConfiguration

DetailedErrorCode

type: string

GetGroupCertificateConfigurationRetrieves the current configuration for the CA used by the group.

URI: GET /greengrass/groups/GroupId/certificateauthorities/configuration/expiry

aws greengrass get-group-certificate-configuration \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

type: string

Responses:200

GroupCertificateConfiguration (p. 496)

{ "GroupId": "string", "CertificateAuthorityExpiryInMilliseconds": "string", "CertificateExpiryInMilliseconds": "string"}

GroupCertificateConfiguration

Information about a group certificate configuration.

type: objectGroupId

The ID of the group certificate configuration.

type: stringCertificateAuthorityExpiryInMilliseconds

The amount of time remaining before the certificate authority expires, in milliseconds.

type: stringCertificateExpiryInMilliseconds

The amount of time remaining before the certificate expires, in milliseconds.

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

GeneralError

type: object

type: array

AWS Greengrass API ReferenceGetGroupVersion

type: string

GetGroupVersionRetrieves information about a group version.

URI: GET /greengrass/groups/GroupId/versions/GroupVersionId

aws greengrass get-group-version \ --group-id <value> \ --group-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "GroupVersionId": "string"}

type: stringGroupVersionId (p. 451)

The ID of the group version.

type: string

Responses:200

success

GetGroupVersionResponse (p. 487)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": {

"CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string" }}

GetGroupVersionResponse

type: objectArn

The ARN of the group version.

type: stringId

type: stringVersion

The unique ID for the version of the group.

The time, in milliseconds since the epoch, when the group version was created.

type: string

LoggerDefinitionVersionArn

type: string400

invalid request

GeneralError

type: object

type: array

type: string

AWS Greengrass API ReferenceGetLoggerDefinition

GetLoggerDefinitionRetrieves information about a logger definition.

URI: GET /greengrass/definition/loggers/LoggerDefinitionId

aws greengrass get-logger-definition \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

type: string

Responses:200 (GetLoggerDefinitionResponse)

type: objectName

AWS Greengrass API ReferenceGetLoggerDefinition

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

type: string

AWS Greengrass API ReferenceGetLoggerDefinitionVersion

ErrorDetails

type: array

type: string

GetLoggerDefinitionVersionRetrieves information about a logger definition version.

URI: GET /greengrass/definition/loggers/LoggerDefinitionId/versions/LoggerDefinitionVersionId

aws greengrass get-logger-definition-version \ --logger-definition-version-id <value> \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "LoggerDefinitionVersionId": "string", "LoggerDefinitionId": "string"}

Parameters:LoggerDefinitionVersionId (p. 451)

The ID of the logger definition version.

type: string

LoggerDefinitionId (p. 451)

type: string

Responses:200 (GetLoggerDefinitionVersionResponse)

success

GetLoggerDefinitionVersionResponse (p. 489)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ] }}

GetLoggerDefinitionVersionResponse

type: objectArn

The ARN of the logger definition version.

type: stringId

type: stringVersion

The version of the logger definition version.

The time, in milliseconds since the epoch, when the logger definition version was created.

type: string

Definition

type: objectLoggers

A list of loggers.

type: array

type: object

type: stringType

type: string

type: integer400

invalid request

AWS Greengrass API ReferenceGetResourceDefinition

GeneralError

type: object

type: array

type: string

GetResourceDefinitionRetrieves information about a resource definition, including its creation time and latest version.

URI: GET /greengrass/definition/resources/ResourceDefinitionId

aws greengrass get-resource-definition \ --resource-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ResourceDefinitionId": "string"

type: string

Responses:200 (GetResourceDefinitionResponse)

success

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceGetResourceDefinitionVersion

type: string

GetResourceDefinitionVersionRetrieves information about a resource definition version, including which resources are included in theversion.

URI: GET /greengrass/definition/resources/ResourceDefinitionId/versions/ResourceDefinitionVersionId

aws greengrass get-resource-definition-version \ --resource-definition-id <value> \ --resource-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ResourceDefinitionId": "string", "ResourceDefinitionVersionId": "string"}

type: stringResourceDefinitionVersionId (p. 453)

The ID of the resource definition version.

type: string

Responses:200

success

GetResourceDefinitionVersionResponse (p. 490)

{ "Arn": "string", "Id": "string",

"Version": "string", "CreationTimestamp": "string", "Definition": { "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ] }}

GetResourceDefinitionVersionResponse

type: objectArn

Arn of the resource definition version.

type: stringId

type: stringVersion

The version of the resource definition version.

The time, in milliseconds since the epoch, when the resource definition version was created.

type: string

Definition

type: array

type: object

type: stringName

type: object

AutoAddGroupOwner

type: string

DestinationPath

type: objectS3Uri

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceGetServiceRoleForAccount

type: string

GetServiceRoleForAccountRetrieves the service role that is attached to your account.

URI: GET /greengrass/servicerole

aws greengrass get-service-role-for-account \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses:200

success

GetServiceRoleForAccountResponse (p. 494)

GetServiceRoleForAccountResponse

type: stringRoleArn

The ARN of the role which is associated with the account.

type: string500

server error

AWS Greengrass API ReferenceGetSubscriptionDefinition

GeneralError

type: object

type: array

type: string

GetSubscriptionDefinitionRetrieves information about a subscription definition.

URI: GET /greengrass/definition/subscriptions/SubscriptionDefinitionId

aws greengrass get-subscription-definition \ --subscription-definition-id <value> \ [--cli-input-json <value>] \

[--generate-cli-skeleton]

type: string

Responses:200 (GetSubscriptionDefinitionResponse)

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceGetSubscriptionDefinitionVersion

type: string

GetSubscriptionDefinitionVersionRetrieves information about a subscription definition version.

URI: GET /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions/SubscriptionDefinitionVersionId

aws greengrass get-subscription-definition-version \ --subscription-definition-id <value> \ --subscription-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "SubscriptionDefinitionId": "string", "SubscriptionDefinitionVersionId": "string"}

type: stringSubscriptionDefinitionVersionId (p. 454)

The ID of the subscription definition version.

type: string

Responses:200 (GetSubscriptionDefinitionVersionResponse)

GetSubscriptionDefinitionVersionResponse (p. 494)

"Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }}

GetSubscriptionDefinitionVersionResponse

type: objectArn

The ARN of the subscription definition version.

type: stringId

type: stringVersion

The version of the subscription definition version.

The time, in milliseconds since the epoch, when the subscription definition version was created.

type: array

type: object

required: ["Id", "Source", "Subject", "Target"]

type: stringSource

type: stringSubject

type: stringTarget

type: string400

invalid request

GeneralError

type: object

type: array

items: ErrorDetail (p. 469)

AWS Greengrass API ReferenceListCoreDefinitionVersions

ErrorDetail

type: string

ListCoreDefinitionVersionsLists the versions of a core definition.

URI: GET /greengrass/definition/cores/CoreDefinitionId/versions

aws greengrass list-core-definition-versions \ --core-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "CoreDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}

type: stringNextToken (p. 452)

The token for the next set of results, or null if there are no additional results.

where used: query; required: false

type: string

MaxResults (p. 452)

The maximum number of results to be returned per request.

type: integer

Responses:200 (ListCoreDefinitionVersionsResponse)

ListVersionsResponse (p. 504)

{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}

ListVersionsResponse

A list of versions.

type: objectVersions

type: array

items: VersionInformation (p. 523)VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string

CreationTimestamp

type: stringNextToken

type: string400

invalid request

GeneralError

type: object

type: array

type: string

AWS Greengrass API ReferenceListCoreDefinitions

ListCoreDefinitionsRetrieves a list of core definitions.

URI: GET /greengrass/definition/cores

aws greengrass list-core-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "MaxResults": "integer", "NextToken": "string"}

Parameters:MaxResults (p. 452)

type: integerNextToken (p. 452)

type: string

Responses:200 (ListCoreDefinitionsResponse)

ListDefinitionsResponse (p. 499)

{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" }

AWS Greengrass API ReferenceListCoreDefinitions

], "NextToken": "string"}

ListDefinitionsResponse

A list of definitions.

type: objectDefinitions

type: array

items: DefinitionInformation (p. 464)DefinitionInformation

type: objectName

type: stringId

type: stringArn

AWS Greengrass API ReferenceListDeployments

type: string

ListDeploymentsReturns a history of deployments for the group.

URI: GET /greengrass/groups/GroupId/deployments

aws greengrass list-deployments \ --group-id <value> \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "MaxResults": "integer", "NextToken": "string"}

type: stringMaxResults (p. 452)

type: string

Responses:200

Success. The response body contains the list of deployments for the given group.

AWS Greengrass API ReferenceListDeployments

ListDeploymentsResponse (p. 501)

{ "Deployments": [ { "GroupArn": "string", "DeploymentId": "string", "DeploymentArn": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "CreatedAt": "string" } ], "NextToken": "string"}

ListDeploymentsResponse

type: objectDeployments

type: array

items: Deployment (p. 465)Deployment

type: objectGroupArn

The ARN of the group for this deployment.

type: stringDeploymentArn

type: stringDeploymentType

type: string

enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]CreatedAt

The time, in milliseconds since the epoch, when the deployment was created.

in: query

AWS Greengrass API ReferenceListDeviceDefinitionVersions

type: string400

invalid request

GeneralError

type: object

type: array

type: string

ListDeviceDefinitionVersionsLists the versions of a device definition.

URI: GET /greengrass/definition/devices/DeviceDefinitionId/versions

aws greengrass list-device-definition-versions \ --device-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "DeviceDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}

type: integer

Responses:200 (ListDeviceDefinitionVersionsResponse)

{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" }

A list of versions.

type: array

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

AWS Greengrass API ReferenceListDeviceDefinitions

GeneralError

type: object

type: array

type: string

ListDeviceDefinitionsRetrieves a list of device definitions.

URI: GET /greengrass/definition/devices

aws greengrass list-device-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

AWS Greengrass API ReferenceListDeviceDefinitions

"MaxResults": "integer", "NextToken": "string"}

type: string

Responses:200 (ListDeviceDefinitionsResponse)

{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}

type: array

type: object

AWS Greengrass API ReferenceListFunctionDefinitionVersions

type: stringId

type: stringArn

type: string

ListFunctionDefinitionVersionsLists the versions of a Lambda function definition.

URI: GET /greengrass/definition/functions/FunctionDefinitionId/versions

aws greengrass list-function-definition-versions \ --function-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "FunctionDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}

type: integer

Responses:200 (ListFunctionDefinitionVersionsResponse)

A list of versions.

type: array

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

AWS Greengrass API ReferenceListFunctionDefinitions

type: array

type: string

ListFunctionDefinitionsRetrieves a list of Lambda function definitions.

URI: GET /greengrass/definition/functions

aws greengrass list-function-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

type: integer

AWS Greengrass API ReferenceListFunctionDefinitions

NextToken (p. 452)

type: string

Responses:200 (ListFunctionDefinitionsResponse)

Success. The response contains the IDs of all the Greengrass Lambda function definitions in thisaccount.

type: array

type: objectName

type: stringId

type: string

AWS Greengrass API ReferenceListGroupCertificateAuthorities

type: string

ListGroupCertificateAuthoritiesRetrieves the current CAs for a group.

URI: GET /greengrass/groups/GroupId/certificateauthorities

aws greengrass list-group-certificate-authorities \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

type: string

Responses:200

ListGroupCertificateAuthoritiesResponse (p. 502)

{ "GroupCertificateAuthorities": [ { "GroupCertificateAuthorityId": "string", "GroupCertificateAuthorityArn": "string" } ]}

ListGroupCertificateAuthoritiesResponse

type: objectGroupCertificateAuthorities

A list of certificate authorities associated with the group.

type: array

items: GroupCertificateAuthorityProperties (p. 496)Group Certificate Authority Properties

type: objectGroupCertificateAuthorityId

type: stringGroupCertificateAuthorityArn

type: string400

invalid request

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string",

"DetailedErrorMessage": "string" } ]}

GeneralError

type: object

Message

type: string

ErrorDetails

type: array

ErrorDetail

type: object

DetailedErrorCode

type: string

DetailedErrorMessage

type: string

server error

GeneralError

AWS Greengrass API ReferenceListGroupVersions

type: object

type: array

type: string

ListGroupVersionsLists the versions of a group.

URI: GET /greengrass/groups/GroupId/versions

aws greengrass list-group-versions \ --group-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "NextToken": "string", "MaxResults": "integer"}

type: integer

Responses:200 (ListGroupVersionsResponse)

Success. The response contains the list of versions and metadata for the given group.

A list of versions.

type: array

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceListGroups

type: string

ListGroupsRetrieves a list of groups.

URI: GET /greengrass/groups

aws greengrass list-groups \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

type: string

AWS Greengrass API ReferenceListGroups

Responses:200 (ListGroupsResponse)

ListGroupsResponse (p. 503)

{ "Groups": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}

ListGroupsResponse

type: objectGroups

Information about a group.

type: array

items: GroupInformation (p. 497)GroupInformation

type: objectName

type: stringId

The ID of the group.

type: stringArn

The ARN of the group.

The time, in milliseconds since the epoch, when the group was last updated.

The time, in milliseconds since the epoch, when the group was created.

AWS Greengrass API ReferenceListLoggerDefinitionVersions

The latest version of the group.

The ARN of the latest version of the group.

type: string

ListLoggerDefinitionVersionsLists the versions of a logger definition.

URI: GET /greengrass/definition/loggers/LoggerDefinitionId/versions

aws greengrass list-logger-definition-versions \ --logger-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "LoggerDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}

type: integer

Responses:200 (ListLoggerDefinitionVersionsResponse)

A list of versions.

type: array

type: objectArn

type: stringId

type: stringVersion

type: string

CreationTimestamp

type: string400

invalid request

GeneralError

type: object

type: array

type: string

AWS Greengrass API ReferenceListLoggerDefinitions

ListLoggerDefinitionsRetrieves a list of logger definitions.

URI: GET /greengrass/definition/loggers

aws greengrass list-logger-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

type: string

Responses:200 (ListLoggerDefinitionsResponse)

{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" }

AWS Greengrass API ReferenceListLoggerDefinitions

type: array

type: objectName

type: stringId

type: stringArn

AWS Greengrass API ReferenceListResourceDefinitionVersions

type: string

ListResourceDefinitionVersionsLists the versions of a resource definition.

URI: GET /greengrass/definition/resources/ResourceDefinitionId/versions

aws greengrass list-resource-definition-versions \ --resource-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ResourceDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}

type: integer

Responses:200 (ListResourceDefinitionVersionsResponse)

AWS Greengrass API ReferenceListResourceDefinitionVersions

A list of versions.

type: array

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

AWS Greengrass API ReferenceListResourceDefinitions

GeneralError

type: object

type: array

type: string

ListResourceDefinitionsRetrieves a list of resource definitions.

URI: GET /greengrass/definition/resources

aws greengrass list-resource-definitions \ [--max-results <value>] \ [--next-token <value>] \

AWS Greengrass API ReferenceListResourceDefinitions

[--cli-input-json <value>] \ [--generate-cli-skeleton]

type: string

Responses:200 (ListResourceDefinitionsResponse)

The IDs of all the Greengrass resource definitions in this account.

AWS Greengrass API ReferenceListSubscriptionDefinitionVersions

type: array

type: objectName

type: stringId

type: stringArn

type: string

ListSubscriptionDefinitionVersionsLists the versions of a subscription definition.

URI: GET /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions

aws greengrass list-subscription-definition-versions \ --subscription-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "SubscriptionDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}

type: integer

Responses:200 (ListSubscriptionDefinitionVersionsResponse)

{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"

A list of versions.

type: array

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

AWS Greengrass API ReferenceListSubscriptionDefinitions

GeneralError

type: object

type: array

type: string

ListSubscriptionDefinitionsRetrieves a list of subscription definitions.

URI: GET /greengrass/definition/subscriptions

aws greengrass list-subscription-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "MaxResults": "integer",

AWS Greengrass API ReferenceListSubscriptionDefinitions

"NextToken": "string"}

type: string

Responses:200 (ListSubscriptionDefinitionsResponse)

type: array

type: object

AWS Greengrass API ReferenceResetDeployments

type: stringId

type: stringArn

type: string

ResetDeploymentsResets a group's deployments.

URI: POST /greengrass/groups/GroupId/deployments/$reset

aws greengrass reset-deployments \ --group-id <value> \ [--force | --no-force] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "Force": "boolean", "AmznClientToken": "string"}

type: stringResetDeploymentsRequestBody (p. 452)

Information needed to reset deployments.

{ "Force": true}

schema:ResetDeploymentsRequest

Information about a group reset request.

type: objectForce

If true, performs a best-effort only core reset.

type: string

Responses:200

Success. The group's deployments were reset.

ResetDeploymentsResponse (p. 510)

{ "DeploymentArn": "string",

"DeploymentId": "string"}

ResetDeploymentsResponse

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceUpdateConnectivityInfo

type: string

UpdateConnectivityInfoUpdates the connectivity information for the core. Any devices that belong to the group which has thiscore will receive this information in order to find the location of the core and connect to it.

URI: PUT /greengrass/things/ThingName/connectivityInfo

aws greengrass update-connectivity-info \ --thing-name <value> \ [--connectivity-info <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ThingName": "string", "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": "int32-integer", "Metadata": "string" } ]}

Parameters:ThingName (p. 454)

The thing name.

type: stringUpdateConnectivityInfoRequestBody (p. 454)

The connectivity information.

where used: body; required:

{ "ConnectivityInfo": [ {

"Id": "string", "HostAddress": "string", "PortNumber": 0x01, "Metadata": "string" } ]}

schema:

Information required to update a Greengrass core's connectivity.ConnectivityInfo

A list of connectivity info.

type: array

type: integer

type: string

Responses:200

success

UpdateConnectivityInfoResponse (p. 522)

{ "message": "string", "Version": "string"}

message

A message about the connectivity info update request.

type: stringVersion

The new version of the connectivity info.

type: string400

invalid request

GeneralError

type: object

type: array

type: string

AWS Greengrass API ReferenceUpdateCoreDefinition

server error

GeneralError

type: object

type: array

type: string

UpdateCoreDefinitionUpdates a core definition.

URI: PUT /greengrass/definition/cores/CoreDefinitionId

AWS Greengrass API ReferenceUpdateCoreDefinition

aws greengrass update-core-definition \ --core-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "CoreDefinitionId": "string", "Name": "string"}

type: stringUpdateDefinitionRequestBody (p. 455)

{ "Name": "string"}

schema:Name

required: true

type: string

Responses:200

success

Empty (p. 469)

Empty Schema

AWS Greengrass API ReferenceUpdateDeviceDefinition

type: object400

invalid request

GeneralError

type: object

type: array

type: string

UpdateDeviceDefinitionUpdates a device definition.

URI: PUT /greengrass/definition/devices/DeviceDefinitionId

AWS Greengrass API ReferenceUpdateDeviceDefinition

aws greengrass update-device-definition \ --device-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "DeviceDefinitionId": "string", "Name": "string"}

{ "Name": "string"}

schema:Name

required: true

type: string

Responses:200

success

Empty (p. 469)

Empty Schema

AWS Greengrass API ReferenceUpdateFunctionDefinition

type: object400

invalid request

GeneralError

type: object

type: array

type: string

UpdateFunctionDefinitionUpdates a Lambda function definition.

URI: PUT /greengrass/definition/functions/FunctionDefinitionId

AWS Greengrass API ReferenceUpdateFunctionDefinition

aws greengrass update-function-definition \ --function-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "FunctionDefinitionId": "string", "Name": "string"}

{ "Name": "string"}

schema:Name

required: true

type: string

Responses:200

success

Empty (p. 469)

Empty Schema

AWS Greengrass API ReferenceUpdateGroup

type: object400

invalid request

GeneralError

type: object

type: array

type: string

UpdateGroupUpdates a group.

URI: PUT /greengrass/groups/GroupId

AWS Greengrass API ReferenceUpdateGroup

aws greengrass update-group \ --group-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "Name": "string"}

{ "Name": "string"}

schema:Name

required: true

type: string

Responses:200

success

Empty (p. 469)

Empty Schema

AWS Greengrass API ReferenceUpdateGroupCertificateConfiguration

type: object400

invalid request

GeneralError

type: object

type: array

type: string

UpdateGroupCertificateConfigurationUpdates the Certificate expiry time for a group.

URI: PUT /greengrass/groups/GroupId/certificateauthorities/configuration/expiry

aws greengrass update-group-certificate-configuration \ --group-id <value> \ [--certificate-expiry-in-milliseconds <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "CertificateExpiryInMilliseconds": "string"}

type: stringUpdateGroupCertificateConfigurationRequestBody (p. 456)

{ "CertificateExpiryInMilliseconds": "string"}

schema:updateGroupCertificateConfigurationRequest

type: object

required: ["CertificateExpiryInMilliseconds"]CertificateExpiryInMilliseconds

type: string

Responses:200

"GroupId": "string", "CertificateAuthorityExpiryInMilliseconds": "string", "CertificateExpiryInMilliseconds": "string"}

type: objectGroupId

type: string400

invalid request

GeneralError

type: object

type: array

ErrorDetail

type: string500

server error

GeneralError

type: object

type: array

AWS Greengrass API ReferenceUpdateLoggerDefinition

type: string

UpdateLoggerDefinitionUpdates a logger definition.

URI: PUT /greengrass/definition/loggers/LoggerDefinitionId

aws greengrass update-logger-definition \ --logger-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "LoggerDefinitionId": "string", "Name": "string"}

{ "Name": "string"}

schema:Name

required: true

type: string

AWS Greengrass API ReferenceUpdateLoggerDefinition

Responses:200

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceUpdateResourceDefinition

type: string

UpdateResourceDefinitionUpdates a resource definition.

URI: PUT /greengrass/definition/resources/ResourceDefinitionId

aws greengrass update-resource-definition \ --resource-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ResourceDefinitionId": "string", "Name": "string"}

{ "Name": "string"}

schema:Name

required: true

type: string

AWS Greengrass API ReferenceUpdateResourceDefinition

Responses:200

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceUpdateSubscriptionDefinition

type: string

UpdateSubscriptionDefinitionUpdates a subscription definition.

URI: PUT /greengrass/definition/subscriptions/SubscriptionDefinitionId

aws greengrass update-subscription-definition \ --subscription-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "SubscriptionDefinitionId": "string", "Name": "string"}

{ "Name": "string"}

schema:Name

required: true

type: string

AWS Greengrass API ReferenceUpdateSubscriptionDefinition

Responses:200

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API ReferenceEndpoints

type: string

EndpointsThe following endpoints are supported:

• /greengrass/definition/cores (p. 214)• /greengrass/definition/cores/CoreDefinitionId (p. 220)• /greengrass/definition/cores/CoreDefinitionId/versions (p. 226)• /greengrass/definition/cores/CoreDefinitionId/versions/CoreDefinitionVersionId (p. 232)• /greengrass/definition/devices (p. 235)• /greengrass/definition/devices/DeviceDefinitionId (p. 241)• /greengrass/definition/devices/DeviceDefinitionId/versions (p. 247)• /greengrass/definition/devices/DeviceDefinitionId/versions/DeviceDefinitionVersionId (p. 254)• /greengrass/definition/functions (p. 257)• /greengrass/definition/functions/FunctionDefinitionId (p. 265)• /greengrass/definition/functions/FunctionDefinitionId/versions (p. 271)• /greengrass/definition/functions/FunctionDefinitionId/versions/

FunctionDefinitionVersionId (p. 279)• /greengrass/definition/loggers (p. 284)• /greengrass/definition/loggers/LoggerDefinitionId (p. 290)• /greengrass/definition/loggers/LoggerDefinitionId/versions (p. 296)• /greengrass/definition/loggers/LoggerDefinitionId/versions/LoggerDefinitionVersionId (p. 303)• /greengrass/definition/resources (p. 306)• /greengrass/definition/resources/ResourceDefinitionId (p. 314)• /greengrass/definition/resources/ResourceDefinitionId/versions (p. 320)• /greengrass/definition/resources/ResourceDefinitionId/versions/

ResourceDefinitionVersionId (p. 329)• /greengrass/definition/subscriptions (p. 334)• /greengrass/definition/subscriptions/SubscriptionDefinitionId (p. 340)• /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions (p. 346)• /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions/

SubscriptionDefinitionVersionId (p. 353)• /greengrass/groups (p. 356)• /greengrass/groups/GroupId (p. 362)• /greengrass/groups/GroupId/certificateauthorities (p. 368)• /greengrass/groups/GroupId/certificateauthorities/configuration/expiry (p. 374)• /greengrass/groups/GroupId/certificateauthorities/CertificateAuthorityId (p. 380)• /greengrass/groups/GroupId/deployments (p. 383)• /greengrass/groups/GroupId/deployments/$reset (p. 389)• /greengrass/groups/GroupId/deployments/DeploymentId/status (p. 391)• /greengrass/groups/GroupId/role (p. 394)

AWS Greengrass API Reference/greengrass/definition/cores

• /greengrass/groups/GroupId/versions (p. 403)• /greengrass/groups/GroupId/versions/GroupVersionId (p. 409)• /greengrass/servicerole (p. 412)• /greengrass/things/ThingName/connectivityInfo (p. 418)• /greengrass/updates (p. 425)

/greengrass/definition/coresGETGET /greengrass/definition/cores

Operation ID: ListCoreDefinitions (p. 153)

Retrieves a list of core definitions.

Query Parameters

MaxResults (p. 452)

type: string

aws greengrass list-core-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (ListCoreDefinitionsResponse)

type: array

type: objectName

type: stringId

type: stringArn

type: string

POSTPOST /greengrass/definition/cores

Operation ID: CreateCoreDefinition (p. 8)

Creates a core definition. You may provide the initial version of the core definition now or useCreateCoreDefinitionVersion at a later time. AWS Greengrass groups must each contain exactlyone AWS Greengrass core.

Body Parameters

CreateCoreDefinitionRequestBody (p. 432)

{ "Name": "string", "InitialVersion": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}

The name of the core definition.

type: objectCores

type: array

items: Core (p. 460)

type: object

type: string

ThingArn

type: string

CertificateArn

type: string

SyncShadow

type: boolean

Header Parameters

type: string

aws greengrass create-core-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string",

"InitialVersion": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ] }, "AmznClientToken": "string"}

Responses

200 (CreateCoreDefinitionResponse)

type: objectName

type: stringId

type: stringArn

type: string

LatestVersion

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId

type: string

/greengrass/definition/cores/CoreDefinitionIdGETGET /greengrass/definition/cores/CoreDefinitionId

Operation ID: GetCoreDefinition (p. 98)

Retrieves information about a core definition version.

Path Parameters

CoreDefinitionId (p. 431)

type: string

aws greengrass get-core-definition \ --core-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (GetCoreDefinitionResponse)

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

Message

type: array

type: string

DELETEDELETE /greengrass/definition/cores/CoreDefinitionId

Operation ID: DeleteCoreDefinition (p. 76)

Deletes a core definition.

Path Parameters

type: string

aws greengrass delete-core-definition \ --core-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

type: string

PUTPUT /greengrass/definition/cores/CoreDefinitionId

Operation ID: UpdateCoreDefinition (p. 195)

Updates a core definition.

Body Parameters

UpdateDefinitionRequestBody (p. 455)

{ "Name": "string"}

required: true

type: string

Path Parameters

type: string

aws greengrass update-core-definition \ --core-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \

[--generate-cli-skeleton]

{ "CoreDefinitionId": "string", "Name": "string"}

Responses

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId/versions

type: string

/greengrass/definition/cores/CoreDefinitionId/versions

POSTPOST /greengrass/definition/cores/CoreDefinitionId/versions

Operation ID: CreateCoreDefinitionVersion (p. 12)

Creates a version of a core definition that has already been defined. AWS Greengrass groups must eachcontain exactly one AWS Greengrass core.

Body Parameters

CreateCoreDefinitionVersionRequestBody (p. 432)

{ "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}

CoreDefinitionVersion

type: objectCores

type: array

items: Core (p. 460)

type: object

type: string

ThingArn

type: string

CertificateArn

type: string

SyncShadow

type: boolean

Header Parameters

type: string

Path Parameters

type: string

aws greengrass create-core-definition-version \

--core-definition-id <value> \ [--cores <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "CoreDefinitionId": "string", "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ], "AmznClientToken": "string"}

Responses

200 (CreateCoreDefinitionVersionResponse)

VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string

invalid request

GeneralError

type: object

type: array

type: string

GETGET /greengrass/definition/cores/CoreDefinitionId/versions

Operation ID: ListCoreDefinitionVersions (p. 150)

Lists the versions of a core definition.

Path Parameters

type: string

Query Parameters

NextToken (p. 452)

type: integer

aws greengrass list-core-definition-versions \ --core-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "CoreDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}

Responses

200 (ListCoreDefinitionVersionsResponse)

{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string"

} ], "NextToken": "string"}

A list of versions.

type: array

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId/

versions/CoreDefinitionVersionId

GeneralError

type: object

type: array

type: string

/greengrass/definition/cores/CoreDefinitionId/versions/CoreDefinitionVersionIdGETGET /greengrass/definition/cores/CoreDefinitionId/versions/CoreDefinitionVersionId

Operation ID: GetCoreDefinitionVersion (p. 100)

Retrieves information about a core definition version.

Path Parameters

type: stringCoreDefinitionVersionId (p. 432)

type: string

aws greengrass get-core-definition-version \ --core-definition-id <value> \ --core-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "CoreDefinitionId": "string", "CoreDefinitionVersionId": "string"}

Responses

success

GetCoreDefinitionVersionResponse (p. 480)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}

type: objectArn

type: string

type: stringVersion

type: objectCores

type: array

type: object

type: boolean400

invalid request

AWS Greengrass API Reference/greengrass/definition/devices

GeneralError

type: object

type: array

type: string

/greengrass/definition/devicesGETGET /greengrass/definition/devices

Operation ID: ListDeviceDefinitions (p. 160)

Retrieves a list of device definitions.

Query Parameters

MaxResults (p. 452)

type: string

aws greengrass list-device-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (ListDeviceDefinitionsResponse)

type: object

Definitions

type: array

type: objectName

type: stringId

type: stringArn

type: string

POSTPOST /greengrass/definition/devices

Operation ID: CreateDeviceDefinition (p. 18)

Creates a device definition. You may provide the initial version of the device definition now or useCreateDeviceDefinitionVersion at a later time.

Body Parameters

CreateDeviceDefinitionRequestBody (p. 434)

{ "Name": "string", "InitialVersion": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}

The name of the device definition.

type: objectDevices

type: array

type: object

type: boolean

Header Parameters

type: string

aws greengrass create-device-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ] }, "AmznClientToken": "string"}

Responses

200 (CreateDeviceDefinitionResponse)

{ "Name": "string", "Id": "string",

"Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string"}

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId

GeneralError

type: object

type: array

type: string

/greengrass/definition/devices/DeviceDefinitionId

GETGET /greengrass/definition/devices/DeviceDefinitionId

Operation ID: GetDeviceDefinition (p. 106)

Retrieves information about a device definition.

Path Parameters

DeviceDefinitionId (p. 449)

type: string

aws greengrass get-device-definition \ --device-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (GetDeviceDefinitionResponse)

type: objectName

type: stringId

type: stringArn

type: string

CreationTimestamp

type: string400

invalid request

GeneralError

type: object

type: array

type: string

DELETEDELETE /greengrass/definition/devices/DeviceDefinitionId

Operation ID: DeleteDeviceDefinition (p. 77)

Deletes a device definition.

Path Parameters

type: string

aws greengrass delete-device-definition \ --device-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

success

Empty (p. 469)

Empty Schema

type: object

invalid request

GeneralError

type: object

type: array

type: string

PUTPUT /greengrass/definition/devices/DeviceDefinitionId

Operation ID: UpdateDeviceDefinition (p. 197)

Updates a device definition.

Body Parameters

{ "Name": "string"}

required: true

type: string

Path Parameters

type: string

aws greengrass update-device-definition \ --device-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "DeviceDefinitionId": "string", "Name": "string"}

Responses

success

Empty (p. 469)

Empty Schema

AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId/versions

type: object400

invalid request

GeneralError

type: object

type: array

type: string

/greengrass/definition/devices/DeviceDefinitionId/versionsPOSTPOST /greengrass/definition/devices/DeviceDefinitionId/versions

Operation ID: CreateDeviceDefinitionVersion (p. 22)

Creates a version of a device definition that has already been defined.

Body Parameters

CreateDeviceDefinitionVersionRequestBody (p. 435)

{ "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}

type: object

Devices

type: array

items: Device (p. 467)

Device

type: object

type: string

ThingArn

type: string

CertificateArn

type: string

SyncShadow

type: boolean

Header Parameters

type: string

Path Parameters

type: string

aws greengrass create-device-definition-version \ --device-definition-id <value> \ [--devices <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "DeviceDefinitionId": "string", "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ], "AmznClientToken": "string"}

Responses

200 (CreateDeviceDefinitionVersionResponse)

"Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string"}

VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: string

ErrorDetails

type: array

type: string

GETGET /greengrass/definition/devices/DeviceDefinitionId/versions

Operation ID: ListDeviceDefinitionVersions (p. 157)

Lists the versions of a device definition.

Path Parameters

type: string

Query Parameters

NextToken (p. 452)

type: integer

aws greengrass list-device-definition-versions \ --device-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "DeviceDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}

Responses

200 (ListDeviceDefinitionVersionsResponse)

A list of versions.

type: array

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId/

versions/DeviceDefinitionVersionId

type: string

/greengrass/definition/devices/DeviceDefinitionId/versions/DeviceDefinitionVersionId

GETGET /greengrass/definition/devices/DeviceDefinitionId/versions/DeviceDefinitionVersionId

Operation ID: GetDeviceDefinitionVersion (p. 108)

Retrieves information about a device definition version.

Path Parameters

type: stringDeviceDefinitionVersionId (p. 450)

type: string

aws greengrass get-device-definition-version \ --device-definition-id <value> \ --device-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

"DeviceDefinitionId": "string", "DeviceDefinitionVersionId": "string"}

Responses

200 (GetDeviceDefinitionVersionResponse)

GetDeviceDefinitionVersionResponse (p. 483)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}

type: object

type: string

Version

type: string

CreationTimestamp

type: string

Definition

type: object

Devices

type: array

type: object

type: boolean400

invalid request

GeneralError

type: object

type: string

AWS Greengrass API Reference/greengrass/definition/functions

ErrorDetails

type: array

type: string

/greengrass/definition/functionsGETGET /greengrass/definition/functions

Operation ID: ListFunctionDefinitions (p. 165)

Retrieves a list of Lambda function definitions.

Query Parameters

MaxResults (p. 452)

type: string

aws greengrass list-function-definitions \ [--max-results <value>] \ [--next-token <value>] \

Responses

200 (ListFunctionDefinitionsResponse)

Success. The response contains the IDs of all the Greengrass Lambda function definitions in thisaccount.

type: array

type: objectName

type: stringId

type: stringArn

type: string

POSTPOST /greengrass/definition/functions

Operation ID: CreateFunctionDefinition (p. 25)

Creates a Lambda function definition which contains a list of Lambda functions and their configurationsto be used in a group. You can create an initial version of the definition by providing a list of Lambdafunctions and their configurations now, or use CreateFunctionDefinitionVersion later.

Body Parameters

CreateFunctionDefinitionRequestBody (p. 436)

{ "Name": "string", "InitialVersion": { "Functions": [ { "Id": "string", "FunctionArn": "string",

"FunctionConfiguration": { "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0, "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ] }}

The name of the function definition.

type: array

type: object

required: ["Id"]Id

type: string

FunctionConfiguration

type: objectPinned

type: string

type: object

type: array

items: ResourceAccessPolicy (p. 513)

ResourceAccessPolicy

type: object

type: string

type: boolean

Header Parameters

type: string

aws greengrass create-function-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": "boolean", "Executable": "string",

"ExecArgs": "string", "MemorySize": "integer", "Timeout": "integer", "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": "boolean" } } } ] }, "AmznClientToken": "string"}

Responses

200 (CreateFunctionDefinitionResponse)

type: objectName

type: stringId

type: stringArn

type: string

type: string400

invalid request

GeneralError

type: object

type: array

type: object

AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId

DetailedErrorCode

type: string

/greengrass/definition/functions/FunctionDefinitionId

GETGET /greengrass/definition/functions/FunctionDefinitionId

Operation ID: GetFunctionDefinition (p. 111)

Retrieves information about a Lambda function definition, including its creation time and latest version.

Path Parameters

FunctionDefinitionId (p. 450)

type: string

aws greengrass get-function-definition \ --function-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (GetFunctionDefinitionResponse)

success

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

{ "Message": "string", "ErrorDetails": [

{ "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}

GeneralError

type: object

type: array

type: string

DELETEDELETE /greengrass/definition/functions/FunctionDefinitionId

Operation ID: DeleteFunctionDefinition (p. 79)

Deletes a Lambda function definition.

Path Parameters

type: string

aws greengrass delete-function-definition \ --function-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

type: string

PUTPUT /greengrass/definition/functions/FunctionDefinitionId

Operation ID: UpdateFunctionDefinition (p. 199)

Updates a Lambda function definition.

Body Parameters

{ "Name": "string"}

required: true

type: string

Path Parameters

type: string

aws greengrass update-function-definition \ --function-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "FunctionDefinitionId": "string", "Name": "string"}

Responses

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

AWS Greengrass API Reference/greengrass/definition/functions/

FunctionDefinitionId/versions

Message

type: array

type: string

/greengrass/definition/functions/FunctionDefinitionId/versionsPOSTPOST /greengrass/definition/functions/FunctionDefinitionId/versions

Operation ID: CreateFunctionDefinitionVersion (p. 31)

Creates a version of a Lambda function definition that has already been defined.

Body Parameters

CreateFunctionDefinitionVersionRequestBody (p. 437)

{ "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string",

"ExecArgs": "string", "MemorySize": 0, "Timeout": 0, "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ]}

FunctionDefinitionVersion

type: array

type: object

required: ["Id"]Id

type: objectPinned

type: string

type: object

type: array

type: object

type: string

type: boolean

Header Parameters

type: string

Path Parameters

type: string

aws greengrass create-function-definition-version \ --function-definition-id <value> \ [--functions <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "FunctionDefinitionId": "string", "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": "boolean", "Executable": "string", "ExecArgs": "string", "MemorySize": "integer",

"Timeout": "integer", "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": "boolean" } } } ], "AmznClientToken": "string"}

Responses

200 (CreateFunctionDefinitionVersionResponse)

VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string

invalid request

GeneralError

type: object

type: array

type: string

GETGET /greengrass/definition/functions/FunctionDefinitionId/versions

Operation ID: ListFunctionDefinitionVersions (p. 162)

Lists the versions of a Lambda function definition.

Path Parameters

type: string

Query Parameters

NextToken (p. 452)

type: integer

aws greengrass list-function-definition-versions \ --function-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "FunctionDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}

Responses

200 (ListFunctionDefinitionVersionsResponse)

{ "Versions": [ { "Arn": "string", "Id": "string",

"Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}

A list of versions.

type: array

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId/

versions/FunctionDefinitionVersionId

GeneralError

type: object

type: array

type: string

/greengrass/definition/functions/FunctionDefinitionId/versions/FunctionDefinitionVersionIdGETGET /greengrass/definition/functions/FunctionDefinitionId/versions/FunctionDefinitionVersionId

Operation ID: GetFunctionDefinitionVersion (p. 114)

Retrieves information about a Lambda function definition version, including which Lambda functions areincluded in the version and their configurations.

Path Parameters

type: stringFunctionDefinitionVersionId (p. 450)

type: string

aws greengrass get-function-definition-version \ --function-definition-id <value> \ --function-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "FunctionDefinitionId": "string", "FunctionDefinitionVersionId": "string"}

Responses

success

GetFunctionDefinitionVersionResponse (p. 484)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0, "EncodingType": "binary|json", "Environment": { "Variables": {

"additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ] }}

type: objectArn

type: stringId

type: stringVersion

type: array

type: object

required: ["Id"]

type: objectPinned

type: string

type: object

type: array

type: object

type: string

type: boolean400

invalid request

GeneralError

type: object

AWS Greengrass API Reference/greengrass/definition/loggers

type: array

type: string

/greengrass/definition/loggers

GETGET /greengrass/definition/loggers

Operation ID: ListLoggerDefinitions (p. 178)

Retrieves a list of logger definitions.

Query Parameters

MaxResults (p. 452)

type: string

aws greengrass list-logger-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (ListLoggerDefinitionsResponse)

type: array

type: objectName

type: string

type: stringArn

type: string

POSTPOST /greengrass/definition/loggers

Operation ID: CreateLoggerDefinition (p. 46)

Creates a logger definition. You may provide the initial version of the logger definition now or useCreateLoggerDefinitionVersion at a later time.

Body Parameters

CreateLoggerDefinitionRequestBody (p. 441)

{ "Name": "string", "InitialVersion": { "Loggers": [

{ "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ] }}

The name of the logger definition.

type: objectLoggers

A list of loggers.

type: array

type: object

type: stringType

type: string

type: integer

Header Parameters

type: string

aws greengrass create-logger-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": "integer" } ] }, "AmznClientToken": "string"}

Responses

200 (CreateLoggerDefinitionResponse)

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

AWS Greengrass API Reference/greengrass/definition/loggers/LoggerDefinitionId

Message

type: array

type: string

/greengrass/definition/loggers/LoggerDefinitionIdGETGET /greengrass/definition/loggers/LoggerDefinitionId

Operation ID: GetLoggerDefinition (p. 130)

Retrieves information about a logger definition.

Path Parameters

type: string

aws greengrass get-logger-definition \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (GetLoggerDefinitionResponse)

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

type: array

type: string

DELETEDELETE /greengrass/definition/loggers/LoggerDefinitionId

Operation ID: DeleteLoggerDefinition (p. 82)

Deletes a logger definition.

Path Parameters

type: string

aws greengrass delete-logger-definition \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

type: string

PUTPUT /greengrass/definition/loggers/LoggerDefinitionId

Operation ID: UpdateLoggerDefinition (p. 207)

Updates a logger definition.

Body Parameters

{ "Name": "string"}

required: true

type: string

Path Parameters

type: string

aws greengrass update-logger-definition \ --logger-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "LoggerDefinitionId": "string", "Name": "string"}

Responses

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string"

AWS Greengrass API Reference/greengrass/definition/loggers/

LoggerDefinitionId/versions

GeneralError

type: object

type: array

type: string

/greengrass/definition/loggers/LoggerDefinitionId/versionsPOSTPOST /greengrass/definition/loggers/LoggerDefinitionId/versions

Operation ID: CreateLoggerDefinitionVersion (p. 49)

Creates a version of a logger definition that has already been defined.

Body Parameters

CreateLoggerDefinitionVersionRequestBody (p. 441)

{ "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ]}

LoggerDefinitionVersion

type: object

Loggers

A list of loggers.

type: array

items: Logger (p. 507)

Logger

type: object

required: ["Id", "Type", "Component", "Level"]

type: string

enum: ["FileSystem", "AWSCloudWatch"]

Component

type: string

enum: ["GreengrassSystem", "Lambda"]

type: string

enum: ["DEBUG", "INFO", "WARN", "ERROR", "FATAL"]

type: integer

Header Parameters

type: string

Path Parameters

type: string

aws greengrass create-logger-definition-version \ --logger-definition-id <value> \ [--loggers <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "LoggerDefinitionId": "string", "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": "integer" } ], "AmznClientToken": "string"}

Responses

200 (CreateLoggerDefinitionVersionResponse)

VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: array

ErrorDetail

type: string

GETGET /greengrass/definition/loggers/LoggerDefinitionId/versions

Operation ID: ListLoggerDefinitionVersions (p. 175)

Lists the versions of a logger definition.

Path Parameters

type: string

Query Parameters

NextToken (p. 452)

type: integer

aws greengrass list-logger-definition-versions \ --logger-definition-id <value> \ [--next-token <value>] \

[--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "LoggerDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}

Responses

200 (ListLoggerDefinitionVersionsResponse)

A list of versions.

type: array

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API Reference/greengrass/definition/loggers/LoggerDefinitionId/

versions/LoggerDefinitionVersionId

type: string

/greengrass/definition/loggers/LoggerDefinitionId/versions/LoggerDefinitionVersionIdGETGET /greengrass/definition/loggers/LoggerDefinitionId/versions/LoggerDefinitionVersionId

Operation ID: GetLoggerDefinitionVersion (p. 132)

Retrieves information about a logger definition version.

Path Parameters

LoggerDefinitionVersionId (p. 451)

type: stringLoggerDefinitionId (p. 451)

type: string

aws greengrass get-logger-definition-version \ --logger-definition-version-id <value> \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "LoggerDefinitionVersionId": "string", "LoggerDefinitionId": "string"}

Responses

200 (GetLoggerDefinitionVersionResponse)

success

GetLoggerDefinitionVersionResponse (p. 489)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ] }}

type: objectArn

type: stringId

type: stringVersion

type: objectLoggers

A list of loggers.

type: array

type: object

type: stringType

type: string

type: integer400

invalid request

GeneralError

type: object

AWS Greengrass API Reference/greengrass/definition/resources

type: array

type: string

/greengrass/definition/resourcesGETGET /greengrass/definition/resources

Operation ID: ListResourceDefinitions (p. 182)

Retrieves a list of resource definitions.

Query Parameters

MaxResults (p. 452)

type: string

aws greengrass list-resource-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (ListResourceDefinitionsResponse)

The IDs of all the Greengrass resource definitions in this account.

type: array

type: objectName

type: stringId

type: stringArn

type: string

POSTPOST /greengrass/definition/resources

Operation ID: CreateResourceDefinition (p. 53)

Creates a resource definition which contains a list of resources to be used in a group. Youcan create an initial version of the definition by providing a list of resources now, or useCreateResourceDefinitionVersion later.

Body Parameters

CreateResourceDefinitionRequestBody (p. 442)

{ "Name": "string", "InitialVersion": { "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" }

}, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ] }}

The name of the resource definition.

type: array

type: object

type: stringName

type: string

ResourceDataContainer

type: object

AutoAddGroupOwner

type: objectS3Uri

type: string

Header Parameters

type: string

aws greengrass create-resource-definition \

[--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": "boolean", "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": "boolean", "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ] }, "AmznClientToken": "string"}

Responses

200 (CreateResourceDefinitionResponse)

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId

type: array

type: string

/greengrass/definition/resources/ResourceDefinitionIdGETGET /greengrass/definition/resources/ResourceDefinitionId

Operation ID: GetResourceDefinition (p. 135)

Retrieves information about a resource definition, including its creation time and latest version.

Path Parameters

ResourceDefinitionId (p. 453)

type: string

aws greengrass get-resource-definition \

--resource-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (GetResourceDefinitionResponse)

success

type: objectName

type: stringId

type: stringArn

type: string

LatestVersion

type: string400

invalid request

GeneralError

type: object

type: array

type: string

DELETEDELETE /greengrass/definition/resources/ResourceDefinitionId

Operation ID: DeleteResourceDefinition (p. 84)

Deletes a resource definition.

Path Parameters

type: string

aws greengrass delete-resource-definition \ --resource-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

type: string

PUTPUT /greengrass/definition/resources/ResourceDefinitionId

Operation ID: UpdateResourceDefinition (p. 209)

Updates a resource definition.

Body Parameters

{ "Name": "string"}

required: true

type: string

Path Parameters

type: string

aws greengrass update-resource-definition \ --resource-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ResourceDefinitionId": "string", "Name": "string"}

Responses

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

AWS Greengrass API Reference/greengrass/definition/resources/

ResourceDefinitionId/versions

GeneralError

type: object

type: array

type: string

/greengrass/definition/resources/ResourceDefinitionId/versionsPOSTPOST /greengrass/definition/resources/ResourceDefinitionId/versions

Operation ID: CreateResourceDefinitionVersion (p. 59)

Creates a version of a resource definition that has already been defined.

Body Parameters

CreateResourceDefinitionVersionRequestBody (p. 443)

{ "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ]}

ResourceDefinitionVersion

type: array

type: object

type: stringName

type: object

SourcePath

type: objectS3Uri

type: string

Header Parameters

type: string

Path Parameters

type: string

aws greengrass create-resource-definition-version \ --resource-definition-id <value> \ [--resources <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ResourceDefinitionId": "string", "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": "boolean", "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": "boolean", "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string"

}, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ], "AmznClientToken": "string"}

Responses

200 (CreateResourceDefinitionVersionResponse)

VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: array

type: string

GETGET /greengrass/definition/resources/ResourceDefinitionId/versions

Operation ID: ListResourceDefinitionVersions (p. 180)

Lists the versions of a resource definition.

Path Parameters

type: string

Query Parameters

NextToken (p. 452)

type: integer

aws greengrass list-resource-definition-versions \ --resource-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ResourceDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}

Responses

200 (ListResourceDefinitionVersionsResponse)

A list of versions.

type: array

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId/

versions/ResourceDefinitionVersionId

type: array

type: string

/greengrass/definition/resources/ResourceDefinitionId/versions/ResourceDefinitionVersionId

GETGET /greengrass/definition/resources/ResourceDefinitionId/versions/ResourceDefinitionVersionId

Operation ID: GetResourceDefinitionVersion (p. 138)

Retrieves information about a resource definition version, including which resources are included in theversion.

Path Parameters

type: string

ResourceDefinitionVersionId (p. 453)

type: string

aws greengrass get-resource-definition-version \ --resource-definition-id <value> \ --resource-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ResourceDefinitionId": "string", "ResourceDefinitionVersionId": "string"}

Responses

success

GetResourceDefinitionVersionResponse (p. 490)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string"

}, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ] }}

type: objectArn

type: stringId

type: stringVersion

type: array

type: object

type: stringName

type: object

type: string

DestinationPath

type: objectS3Uri

type: string400

invalid request

AWS Greengrass API Reference/greengrass/definition/subscriptions

GeneralError

type: object

type: array

type: string

/greengrass/definition/subscriptionsGETGET /greengrass/definition/subscriptions

Operation ID: ListSubscriptionDefinitions (p. 187)

Retrieves a list of subscription definitions.

Query Parameters

MaxResults (p. 452)

type: string

aws greengrass list-subscription-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (ListSubscriptionDefinitionsResponse)

type: object

Definitions

type: array

type: objectName

type: stringId

type: stringArn

type: string

POSTPOST /greengrass/definition/subscriptions

Operation ID: CreateSubscriptionDefinition (p. 69)

Creates a subscription definition. You may provide the initial version of the subscription definition now oruse CreateSubscriptionDefinitionVersion at a later time.

Body Parameters

CreateSubscriptionDefinitionRequestBody (p. 447)

{ "Name": "string", "InitialVersion": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }}

The name of the subscription definition.

type: array

type: object

type: stringSource

type: string

Subject

type: stringTarget

type: string

Header Parameters

type: string

aws greengrass create-subscription-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }, "AmznClientToken": "string"}

Responses

200 (CreateSubscriptionDefinitionResponse)

{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string",

"CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string"}

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

AWS Greengrass API Reference/greengrass/definition/

subscriptions/SubscriptionDefinitionId

GeneralError

type: object

type: array

type: string

/greengrass/definition/subscriptions/SubscriptionDefinitionIdGETGET /greengrass/definition/subscriptions/SubscriptionDefinitionId

Operation ID: GetSubscriptionDefinition (p. 144)

Retrieves information about a subscription definition.

Path Parameters

SubscriptionDefinitionId (p. 453)

type: string

aws greengrass get-subscription-definition \ --subscription-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (GetSubscriptionDefinitionResponse)

type: objectName

type: stringId

type: stringArn

type: string

LatestVersion

type: string400

invalid request

GeneralError

type: object

type: array

type: string

DELETEDELETE /greengrass/definition/subscriptions/SubscriptionDefinitionId

Operation ID: DeleteSubscriptionDefinition (p. 86)

Deletes a subscription definition.

Path Parameters

type: string

aws greengrass delete-subscription-definition \ --subscription-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

type: string

PUTPUT /greengrass/definition/subscriptions/SubscriptionDefinitionId

Operation ID: UpdateSubscriptionDefinition (p. 211)

Updates a subscription definition.

Body Parameters

{ "Name": "string"}

required: true

type: string

Path Parameters

type: string

aws greengrass update-subscription-definition \ --subscription-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "SubscriptionDefinitionId": "string", "Name": "string"}

Responses

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

AWS Greengrass API Reference/greengrass/definition/subscriptions/

SubscriptionDefinitionId/versions

GeneralError

type: object

type: array

type: string

/greengrass/definition/subscriptions/SubscriptionDefinitionId/versionsPOSTPOST /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions

Operation ID: CreateSubscriptionDefinitionVersion (p. 72)

Creates a version of a subscription definition which has already been defined.

Body Parameters

CreateSubscriptionDefinitionVersionRequestBody (p. 448)

{ "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ]}

SubscriptionDefinitionVersion

type: array

type: object

type: stringSource

type: stringSubject

type: stringTarget

type: string

Header Parameters

type: string

Path Parameters

type: string

aws greengrass create-subscription-definition-version \ --subscription-definition-id <value> \ [--subscriptions <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "SubscriptionDefinitionId": "string", "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ], "AmznClientToken": "string"}

Responses

200 (CreateSubscriptionDefinitionVersionResponse)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string"

VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: array

type: string

GETGET /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions

Operation ID: ListSubscriptionDefinitionVersions (p. 184)

Lists the versions of a subscription definition.

Path Parameters

type: string

Query Parameters

NextToken (p. 452)

type: integer

aws greengrass list-subscription-definition-versions \

--subscription-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "SubscriptionDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}

Responses

200 (ListSubscriptionDefinitionVersionsResponse)

A list of versions.

type: array

type: objectArn

type: stringId

type: string

Version

type: string400

invalid request

GeneralError

type: object

type: array

SubscriptionDefinitionId/versions/SubscriptionDefinitionVersionId

type: string

/greengrass/definition/subscriptions/SubscriptionDefinitionId/versions/SubscriptionDefinitionVersionId

GETGET /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions/SubscriptionDefinitionVersionId

Operation ID: GetSubscriptionDefinitionVersion (p. 147)

Retrieves information about a subscription definition version.

Path Parameters

type: stringSubscriptionDefinitionVersionId (p. 454)

type: string

aws greengrass get-subscription-definition-version \ --subscription-definition-id <value> \ --subscription-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "SubscriptionDefinitionId": "string", "SubscriptionDefinitionVersionId": "string"}

Responses

200 (GetSubscriptionDefinitionVersionResponse)

GetSubscriptionDefinitionVersionResponse (p. 494)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }}

type: objectArn

type: stringId

type: stringVersion

type: array

items: Subscription (p. 520)

Subscription

type: object

type: stringSource

type: stringSubject

type: stringTarget

type: string400

invalid request

GeneralError

type: object

type: string

AWS Greengrass API Reference/greengrass/groups

ErrorDetails

type: array

type: string

/greengrass/groups

GETGET /greengrass/groups

Operation ID: ListGroups (p. 173)

Retrieves a list of groups.

Query Parameters

MaxResults (p. 452)

type: string

aws greengrass list-groups \

[--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (ListGroupsResponse)

ListGroupsResponse (p. 503)

{ "Groups": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}

ListGroupsResponse

type: object

Groups

type: array

items: GroupInformation (p. 497)

GroupInformation

type: object

type: string

POSTPOST /greengrass/groups

Operation ID: CreateGroup (p. 36)

Creates a group. You may provide the initial version of the group or use CreateGroupVersion at a latertime.

Body Parameters

CreateGroupRequestBody (p. 439)

{ "Name": "string", "InitialVersion": { "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string" }

type: string

Header Parameters

type: string

aws greengrass create-group \

[--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "Name": "string", "InitialVersion": { "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string" }, "AmznClientToken": "string"}

Responses

200 (CreateGroupResponse)

Success. The group was created.

type: objectName

type: stringId

type: stringArn

type: string

type: string400

invalid request

GeneralError

type: object

type: array

type: object

AWS Greengrass API Reference/greengrass/groups/GroupId

DetailedErrorCode

type: string

/greengrass/groups/GroupId

GETGET /greengrass/groups/GroupId

Operation ID: GetGroup (p. 118)

Retrieves information about a group.

Path Parameters

GroupId (p. 450)

type: string

aws greengrass get-group \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

200 (GetGroupResponse)

success

"Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string"}

type: objectName

type: stringId

type: stringArn

type: string400

invalid request

GeneralError

type: object

type: array

type: string

DELETEDELETE /greengrass/groups/GroupId

Operation ID: DeleteGroup (p. 81)

Deletes a group.

Path Parameters

GroupId (p. 450)

type: string

aws greengrass delete-group \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

type: array

type: string

PUTPUT /greengrass/groups/GroupId

Operation ID: UpdateGroup (p. 201)

Updates a group.

Body Parameters

{ "Name": "string"}

required: true

type: string

Path Parameters

GroupId (p. 450)

type: string

aws greengrass update-group \ --group-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "Name": "string"}

Responses

success

Empty (p. 469)

Empty Schema

type: object400

invalid request

GeneralError

type: object

AWS Greengrass API Reference/greengrass/groups/GroupId/certificateauthorities

Message

type: array

type: string

/greengrass/groups/GroupId/certificateauthoritiesGETGET /greengrass/groups/GroupId/certificateauthorities

Operation ID: ListGroupCertificateAuthorities (p. 167)

Retrieves the current CAs for a group.

Path Parameters

GroupId (p. 450)

type: string

aws greengrass list-group-certificate-authorities \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

ListGroupCertificateAuthoritiesResponse (p. 502)

{ "GroupCertificateAuthorities": [ { "GroupCertificateAuthorityId": "string", "GroupCertificateAuthorityArn": "string" } ]}

type: array

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

GeneralError

type: object

type: array

type: string

POSTPOST /greengrass/groups/GroupId/certificateauthorities

Operation ID: CreateGroupCertificateAuthority (p. 40)

Creates a CA for the group. If a CA already exists, it will rotate the existing CA.

Header Parameters

type: string

Path Parameters

GroupId (p. 450)

type: string

aws greengrass create-group-certificate-authority \ --group-id <value> \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "AmznClientToken": "string"}

Responses

Success. The response body contains the new active CA ARN.

CreateGroupCertificateAuthorityResponse (p. 462)

{ "GroupCertificateAuthorityArn": "string"}

type: objectGroupCertificateAuthorityArn

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

GeneralError

type: object

AWS Greengrass API Reference/greengrass/groups/GroupId/

certificateauthorities/configuration/expiry

type: array

type: string

/greengrass/groups/GroupId/certificateauthorities/configuration/expiry

GETGET /greengrass/groups/GroupId/certificateauthorities/configuration/expiry

Operation ID: GetGroupCertificateConfiguration (p. 124)

Retrieves the current configuration for the CA used by the group.

Path Parameters

GroupId (p. 450)

type: string

aws greengrass get-group-certificate-configuration \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

type: objectGroupId

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

GeneralError

type: object

type: array

ErrorDetail

type: string

PUTPUT /greengrass/groups/GroupId/certificateauthorities/configuration/expiry

Operation ID: UpdateGroupCertificateConfiguration (p. 203)

Updates the Certificate expiry time for a group.

Body Parameters

UpdateGroupCertificateConfigurationRequestBody (p. 456)

{ "CertificateExpiryInMilliseconds": "string"}

updateGroupCertificateConfigurationRequest

type: object

type: string

Path Parameters

GroupId (p. 450)

type: string

aws greengrass update-group-certificate-configuration \ --group-id <value> \ [--certificate-expiry-in-milliseconds <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "CertificateExpiryInMilliseconds": "string"}

Responses

type: objectGroupId

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

GeneralError

certificateauthorities/CertificateAuthorityId

type: object

type: array

type: string

/greengrass/groups/GroupId/certificateauthorities/CertificateAuthorityId

GETGET /greengrass/groups/GroupId/certificateauthorities/CertificateAuthorityId

Operation ID: GetGroupCertificateAuthority (p. 121)

Retreives the CA associated with a group. Returns the public key of the CA.

Path Parameters

GroupId (p. 450)

type: stringCertificateAuthorityId (p. 431)

type: string

aws greengrass get-group-certificate-authority \ --group-id <value> \ --certificate-authority-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "CertificateAuthorityId": "string"}

Responses

GetGroupCertificateAuthorityResponse (p. 487)

{ "PemEncodedCertificate": "string", "GroupCertificateAuthorityArn": "string", "GroupCertificateAuthorityId": "string"}

type: objectPemEncodedCertificate

type: stringGroupCertificateAuthorityId

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

AWS Greengrass API Reference/greengrass/groups/GroupId/deployments

GeneralError

type: object

type: array

type: string

/greengrass/groups/GroupId/deploymentsPOSTPOST /greengrass/groups/GroupId/deployments

Operation ID: CreateDeployment (p. 15)

Creates a deployment.

Body Parameters

CreateDeploymentRequestBody (p. 433)

{ "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string"}

CreateDeploymentRequest

type: object

type: string

enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]DeploymentId

type: string

Header Parameters

type: string

Path Parameters

GroupId (p. 450)

type: string

aws greengrass create-deployment \ --group-id <value> \ [--deployment-type <value>] \ [--deployment-id <value>] \ [--group-version-id <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

"GroupId": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string", "AmznClientToken": "string"}

Responses

Success. The group was deployed.

CreateDeploymentResponse (p. 462)

type: string400

invalid request

GeneralError

type: object

type: array

type: string

GETGET /greengrass/groups/GroupId/deployments

Operation ID: ListDeployments (p. 155)

Returns a history of deployments for the group.

Path Parameters

GroupId (p. 450)

type: string

Query Parameters

MaxResults (p. 452)

type: string

aws greengrass list-deployments \ --group-id <value> \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "MaxResults": "integer", "NextToken": "string"}

Responses

Success. The response body contains the list of deployments for the given group.

ListDeploymentsResponse (p. 501)

{ "Deployments": [ { "GroupArn": "string", "DeploymentId": "string", "DeploymentArn": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "CreatedAt": "string" } ], "NextToken": "string"}

type: array

type: string

DeploymentId

type: string

in: query

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API Reference/greengrass/groups/GroupId/deployments/$reset

type: string

/greengrass/groups/GroupId/deployments/$resetPOSTPOST /greengrass/groups/GroupId/deployments/$reset

Operation ID: ResetDeployments (p. 189)

Resets a group's deployments.

Body Parameters

ResetDeploymentsRequestBody (p. 452)

{ "Force": true}

ResetDeploymentsRequest

type: objectForce

type: boolean

Header Parameters

AWS Greengrass API Reference/greengrass/groups/GroupId/deployments/$reset

type: string

Path Parameters

GroupId (p. 450)

type: string

aws greengrass reset-deployments \ --group-id <value> \ [--force | --no-force] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "Force": "boolean", "AmznClientToken": "string"}

Responses

Success. The group's deployments were reset.

ResetDeploymentsResponse (p. 510)

type: string

deployments/DeploymentId/status

invalid request

GeneralError

type: object

type: array

type: string

/greengrass/groups/GroupId/deployments/DeploymentId/statusGETGET /greengrass/groups/GroupId/deployments/DeploymentId/status

Operation ID: GetDeploymentStatus (p. 103)

Returns the status of a deployment.

Path Parameters

GroupId (p. 450)

type: stringDeploymentId (p. 449)

type: string

aws greengrass get-deployment-status \ --group-id <value> \ --deployment-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "DeploymentId": "string"}

Responses

Success. The response body contains the status of the deployment for the group.

GetDeploymentStatusResponse (p. 481)

{ "DeploymentStatus": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "UpdatedAt": "string", "ErrorMessage": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}

type: objectDeploymentStatus

type: string

enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]UpdatedAt

type: stringErrorMessage

Error message

type: array

type: string400

invalid request

AWS Greengrass API Reference/greengrass/groups/GroupId/role

GeneralError

type: object

type: array

type: string

/greengrass/groups/GroupId/role

PUTPUT /greengrass/groups/GroupId/role

Operation ID: AssociateRoleToGroup (p. 3)

Associates a role with a group. Your AWS Greengrass core will use the role to access AWS cloud services.The role's permissions should allow Greengrass core Lambda functions to perform actions against thecloud.

Body Parameters

AssociateRoleToGroupRequestBody (p. 430)

AssociateRoleToGroupRequest

type: object

type: string

Path Parameters

GroupId (p. 450)

type: string

aws greengrass associate-role-to-group \ --group-id <value> \ [--role-arn <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "RoleArn": "string"}

Responses

success

AssociateRoleToGroupResponse (p. 496)

type: object

AssociatedAt

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

GeneralError

type: object

type: array

type: string

DELETEDELETE /greengrass/groups/GroupId/role

Operation ID: DisassociateRoleFromGroup (p. 88)

Disassociates the role from a group.

Path Parameters

GroupId (p. 450)

type: string

aws greengrass disassociate-role-from-group \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

success

DisassociateRoleFromGroupResponse (p. 468)

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

GeneralError

type: object

type: array

type: string

GETGET /greengrass/groups/GroupId/role

Operation ID: GetAssociatedRole (p. 92)

Retrieves the role associated with a particular group.

Path Parameters

GroupId (p. 450)

type: string

aws greengrass get-associated-role \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

success

GetAssociatedRoleResponse (p. 479)

type: stringRoleArn

type: string400

invalid request

GeneralError

type: object

type: array

type: object

DetailedErrorCode

type: string500

server error

GeneralError

type: object

type: array

type: string

AWS Greengrass API Reference/greengrass/groups/GroupId/versions

/greengrass/groups/GroupId/versions

POSTPOST /greengrass/groups/GroupId/versions

Operation ID: CreateGroupVersion (p. 42)

Creates a version of a group which has already been defined.

Body Parameters

CreateGroupVersionRequestBody (p. 440)

{ "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string"}

GroupVersion

type: string

ResourceDefinitionVersionArn

type: string

Header Parameters

type: string

Path Parameters

GroupId (p. 450)

type: string

aws greengrass create-group-version \ --group-id <value> \ [--core-definition-version-arn <value>] \ [--device-definition-version-arn <value>] \ [--function-definition-version-arn <value>] \ [--subscription-definition-version-arn <value>] \ [--logger-definition-version-arn <value>] \ [--resource-definition-version-arn <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string", "AmznClientToken": "string"}

Responses

200 (CreateGroupVersionResponse)

Success. The response contains information about the group version.

VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: array

type: string

GETGET /greengrass/groups/GroupId/versions

Operation ID: ListGroupVersions (p. 170)

Lists the versions of a group.

Path Parameters

GroupId (p. 450)

type: string

Query Parameters

NextToken (p. 452)

type: integer

aws greengrass list-group-versions \ --group-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "NextToken": "string", "MaxResults": "integer"}

Responses

200 (ListGroupVersionsResponse)

Success. The response contains the list of versions and metadata for the given group.

A list of versions.

type: array

type: objectArn

type: stringId

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API Reference/greengrass/groups/GroupId/versions/GroupVersionId

type: string

/greengrass/groups/GroupId/versions/GroupVersionIdGETGET /greengrass/groups/GroupId/versions/GroupVersionId

Operation ID: GetGroupVersion (p. 127)

Retrieves information about a group version.

Path Parameters

GroupId (p. 450)

type: stringGroupVersionId (p. 451)

type: string

aws greengrass get-group-version \ --group-id <value> \ --group-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "GroupId": "string", "GroupVersionId": "string"

Responses

success

GetGroupVersionResponse (p. 487)

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string" }}

type: objectArn

type: stringId

type: stringVersion

type: string

DeviceDefinitionVersionArn

type: string400

invalid request

GeneralError

type: object

type: array

AWS Greengrass API Reference/greengrass/servicerole

ErrorDetail

type: string

/greengrass/servicerole

PUTPUT /greengrass/servicerole

Operation ID: AssociateServiceRoleToAccount (p. 6)

Associates a role with your account. AWS Greengrass will use the role to access your Lambda functionsand AWS IoT resources. This is necessary for deployments to succeed. The role must have at leastminimum permissions in the policy AWSGreengrassResourceAccessRolePolicy.

Body Parameters

AssociateServiceRoleToAccountRequestBody (p. 431)

AssociateServiceRoleToAccountRequest

type: object

type: string

aws greengrass associate-service-role-to-account \ [--role-arn <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

success

AssociateServiceRoleToAccountResponse (p. 459)

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

GeneralError

type: object

type: array

type: string

DELETEDELETE /greengrass/servicerole

Operation ID: DisassociateServiceRoleFromAccount (p. 90)

Disassociates the service role from your account. Without a service role, deployments will not work.

aws greengrass disassociate-service-role-from-account \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

success

DisassociateServiceRoleFromAccountResponse (p. 469)

type: string500

server error

GeneralError

type: object

type: array

type: string

GETGET /greengrass/servicerole

Operation ID: GetServiceRoleForAccount (p. 143)

Retrieves the service role that is attached to your account.

aws greengrass get-service-role-for-account \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

Responses

success

GetServiceRoleForAccountResponse (p. 494)

type: stringRoleArn

type: string500

server error

GeneralError

type: object

type: array

type: object

AWS Greengrass API Reference/greengrass/things/ThingName/connectivityInfo

DetailedErrorCode

type: string

/greengrass/things/ThingName/connectivityInfo

GETGET /greengrass/things/ThingName/connectivityInfo

Operation ID: GetConnectivityInfo (p. 94)

Retrieves the connectivity information for a core.

Path Parameters

ThingName (p. 454)

The thing name.

type: string

aws greengrass get-connectivity-info \ --thing-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "ThingName": "string"}

Responses

success

GetConnectivityInfoResponse (p. 479)

"message": "string", "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": 0x01, "Metadata": "string" } ]}

type: array

type: integer

type: string400

invalid request

GeneralError

type: object

Message

type: string

ErrorDetails

type: array

ErrorDetail

type: object

DetailedErrorCode

type: string

server error

GeneralError

type: object

type: array

type: string

PUTPUT /greengrass/things/ThingName/connectivityInfo

Operation ID: UpdateConnectivityInfo (p. 192)

Updates the connectivity information for the core. Any devices that belong to the group which has thiscore will receive this information in order to find the location of the core and connect to it.

Body Parameters

UpdateConnectivityInfoRequestBody (p. 454)

where used: body; required:

{ "ConnectivityInfo": [ { "Id": "string",

"HostAddress": "string", "PortNumber": 0x01, "Metadata": "string" } ]}

type: array

type: integer

type: string

Path Parameters

ThingName (p. 454)

The thing name.

type: string

aws greengrass update-connectivity-info \ --thing-name <value> \ [--connectivity-info <value>] \

{ "ThingName": "string", "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": "int32-integer", "Metadata": "string" } ]}

Responses

success

UpdateConnectivityInfoResponse (p. 522)

{ "message": "string", "Version": "string"}

message

type: stringVersion

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

GeneralError

type: object

type: string

AWS Greengrass API Reference/greengrass/updates

ErrorDetails

type: array

type: string

/greengrass/updates

POSTPOST /greengrass/updates

Operation ID: CreateSoftwareUpdateJob (p. 65)

Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this toupdate the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs featurewhich provides additional commands to manage a Greengrass core software update job.

Body Parameters

CreateSoftwareUpdateJobRequestBody (p. 446)

{ "UpdateTargetsArchitecture": "armv7l|x86_64|aarch64", "UpdateTargets": [ "string" ], "SoftwareToUpdate": "core|ota_agent", "S3UrlSignerRole": "string", "UpdateAgentLogLevel": "NONE|TRACE|DEBUG|VERBOSE|INFO|WARN|ERROR|FATAL", "UpdateTargetsOperatingSystem": "ubuntu|raspbian|amazon_linux"}

CreateSoftwareUpdateJobRequest

type: object

required: ["UpdateTargetsArchitecture", "UpdateTargets", "SoftwareToUpdate","S3UrlSignerRole", "UpdateTargetsOperatingSystem"]

type: string

The minimum level of log statements that should be logged by the OTA Agent during anupdate.

type: string

enum: ["ubuntu", "raspbian", "amazon_linux"]

Header Parameters

type: string

aws greengrass create-software-update-job \

[--update-targets-architecture <value>] \ [--update-targets <value>] \ [--software-to-update <value>] \ [--s3-url-signer-role <value>] \ [--update-agent-log-level <value>] \ [--update-targets-operating-system <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

{ "UpdateTargetsArchitecture": "armv7l|x86_64|aarch64", "UpdateTargets": [ "string" ], "SoftwareToUpdate": "core|ota_agent", "S3UrlSignerRole": "string", "UpdateAgentLogLevel": "NONE|TRACE|DEBUG|VERBOSE|INFO|WARN|ERROR|FATAL", "UpdateTargetsOperatingSystem": "ubuntu|raspbian|amazon_linux", "AmznClientToken": "string"}

Responses

success

CreateSoftwareUpdateJobResponse (p. 464)

{ "IotJobId": "string", "IotJobArn": "string"}

type: string400

invalid request

GeneralError

type: object

type: array

type: string500

server error

GeneralError

AWS Greengrass API ReferenceParameters

type: object

type: array

type: string

ParametersThe following parameters are used:

• AssociateRoleToGroupRequestBody (p. 430)• AssociateServiceRoleToAccountRequestBody (p. 431)• CertificateAuthorityId (p. 431)• CoreDefinitionId (p. 431)• CoreDefinitionVersionId (p. 432)• CreateCoreDefinitionRequestBody (p. 432)• CreateCoreDefinitionVersionRequestBody (p. 432)• CreateDeploymentRequestBody (p. 433)• CreateDeviceDefinitionRequestBody (p. 434)• CreateDeviceDefinitionVersionRequestBody (p. 435)• CreateFunctionDefinitionRequestBody (p. 436)• CreateFunctionDefinitionVersionRequestBody (p. 437)• CreateGroupRequestBody (p. 439)• CreateGroupVersionRequestBody (p. 440)• CreateLoggerDefinitionRequestBody (p. 441)• CreateLoggerDefinitionVersionRequestBody (p. 441)• CreateResourceDefinitionRequestBody (p. 442)

AWS Greengrass API ReferenceAssociateRoleToGroupRequestBody

• CreateResourceDefinitionVersionRequestBody (p. 443)• CreateSoftwareUpdateJobRequestBody (p. 446)• CreateSubscriptionDefinitionRequestBody (p. 447)• CreateSubscriptionDefinitionVersionRequestBody (p. 448)• DeploymentId (p. 449)• DeviceDefinitionId (p. 449)• DeviceDefinitionVersionId (p. 450)• FunctionDefinitionId (p. 450)• FunctionDefinitionVersionId (p. 450)• GroupId (p. 450)• GroupVersionId (p. 451)• LoggerDefinitionId (p. 451)• LoggerDefinitionVersionId (p. 451)• MaxResults (p. 452)• NextToken (p. 452)• ResetDeploymentsRequestBody (p. 452)• ResourceDefinitionId (p. 453)• ResourceDefinitionVersionId (p. 453)• SubscriptionDefinitionId (p. 453)• SubscriptionDefinitionVersionId (p. 454)• ThingName (p. 454)• UpdateConnectivityInfoRequestBody (p. 454)• UpdateDefinitionRequestBody (p. 455)• UpdateGroupCertificateConfigurationRequestBody (p. 456)• X-Amzn-Client-Token (p. 456)

AssociateRoleToGroupRequestBody{ "RoleArn": "string"}

AssociateRoleToGroupRequestBody

in: body

required: true

schema: AssociateRoleToGroupRequest (p. 458)AssociateRoleToGroupRequest

type: object

type: string

AWS Greengrass API ReferenceAssociateServiceRoleToAccountRequestBody

AssociateServiceRoleToAccountRequestBody{ "RoleArn": "string"}

AssociateServiceRoleToAccountRequestBody

in: body

required: true

schema: AssociateServiceRoleToAccountRequest (p. 459)AssociateServiceRoleToAccountRequest

type: object

type: string

CertificateAuthorityId{ "CertificateAuthorityId": "string"}

CertificateAuthorityId

in: path

required: true

type: string

CoreDefinitionId{ "CoreDefinitionId": "string"}

CoreDefinitionId

in: path

required: true

type: string

AWS Greengrass API ReferenceCoreDefinitionVersionId

CoreDefinitionVersionId{ "CoreDefinitionVersionId": "string"}

CoreDefinitionVersionId

in: path

required: true

type: string

CreateCoreDefinitionRequestBody{ "Name": "string", "InitialVersion": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}

CreateCoreDefinitionRequestBody

in: body

required: trueproperties

Name: "description"=>"The name of the core definition.", "type"=>"string"

InitialVersion: "$ref"=>"#/definitions/CoreDefinitionVersion","description"=>"Information about the initial version of the coredefinition."

CreateCoreDefinitionVersionRequestBody{ "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string",

AWS Greengrass API ReferenceCreateDeploymentRequestBody

"SyncShadow": true } ]}

CreateCoreDefinitionVersionRequestBody

in: body

required: true

schema: CoreDefinitionVersion (p. 460)CoreDefinitionVersion

type: objectCores

type: array

type: object

type: boolean

CreateDeploymentRequestBody{

AWS Greengrass API ReferenceCreateDeviceDefinitionRequestBody

"DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string"}

CreateDeploymentRequestBody

in: body

required: true

schema: CreateDeploymentRequest (p. 461)CreateDeploymentRequest

type: object

type: string

CreateDeviceDefinitionRequestBody{ "Name": "string", "InitialVersion": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}

CreateDeviceDefinitionRequestBody

in: body

required: true

AWS Greengrass API ReferenceCreateDeviceDefinitionVersionRequestBody

properties

Name: "description"=>"The name of the device definition.", "type"=>"string"

InitialVersion: "$ref"=>"#/definitions/DeviceDefinitionVersion","description"=>"Information about the initial version of the devicedefinition."

CreateDeviceDefinitionVersionRequestBody{ "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}

CreateDeviceDefinitionVersionRequestBody

in: body

required: true

schema: DeviceDefinitionVersion (p. 467)DeviceDefinitionVersion

type: objectDevices

type: array

type: object

A descriptive or arbitrary ID for the device. This value must be unique within the device definitionversion. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.

type: string

AWS Greengrass API ReferenceCreateFunctionDefinitionRequestBody

CertificateArn

type: boolean

CreateFunctionDefinitionRequestBody{ "Name": "string", "InitialVersion": { "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0, "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ] }}

CreateFunctionDefinitionRequestBody

in: body

Name: "description"=>"The name of the function definition.","type"=>"string"

InitialVersion: "$ref"=>"#/definitions/FunctionDefinitionVersion","description"=>"Information about the initial version of the functiondefinition."

AWS Greengrass API ReferenceCreateFunctionDefinitionVersionRequestBody

CreateFunctionDefinitionVersionRequestBody{ "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0, "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ]}

CreateFunctionDefinitionVersionRequestBody

in: body

required: true

schema: FunctionDefinitionVersion (p. 475)FunctionDefinitionVersion

type: array

type: object

required: ["Id"]

AWS Greengrass API ReferenceCreateFunctionDefinitionVersionRequestBody

type: objectPinned

type: string

AWS Greengrass API ReferenceCreateGroupRequestBody

type: object

additionalProperties: "type"=>"string"

ResourceAccessPolicies

A list of the resources, with their permissions, to which the Lambda function will be granted access.A Lambda function can have at most 10 resources.

type: array

items: ResourceAccessPolicy (p. 513)

type: object

required: ["ResourceId"]

ResourceId

The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)

type: string

Permission

type: string

enum: ["ro", "rw"]

AccessSysfs

If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambdafunction needs to read device information from /sys.

type: boolean

CreateGroupRequestBody{ "Name": "string", "InitialVersion": { "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string" }}

CreateGroupRequestBody

in: body

required: true

AWS Greengrass API ReferenceCreateGroupVersionRequestBody

properties

Name: "description"=>"The name of the group.", "type"=>"string"

InitialVersion: "$ref"=>"#/definitions/GroupVersion", "description"=>"Informationabout the initial version of the group."

CreateGroupVersionRequestBody{ "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string"}

CreateGroupVersionRequestBody

in: body

required: true

schema: GroupVersion (p. 498)GroupVersion

AWS Greengrass API ReferenceCreateLoggerDefinitionRequestBody

type: string

CreateLoggerDefinitionRequestBody{ "Name": "string", "InitialVersion": { "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ] }}

CreateLoggerDefinitionRequestBody

in: body

required: true

properties

Name: "description"=>"The name of the logger definition.", "type"=>"string"

InitialVersion: "$ref"=>"#/definitions/LoggerDefinitionVersion","description"=>"Information about the initial version of the loggerdefinition."

CreateLoggerDefinitionVersionRequestBody{ "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ]}

CreateLoggerDefinitionVersionRequestBody

in: body

required: true

schema: LoggerDefinitionVersion (p. 508)

AWS Greengrass API ReferenceCreateResourceDefinitionRequestBody

type: objectLoggers

A list of loggers.

type: array

type: object

A descriptive or arbitrary ID for the logger. This value must be unique within the logger definitionversion. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.

type: stringType

type: string

type: integer

CreateResourceDefinitionRequestBody{ "Name": "string", "InitialVersion": { "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string"

AWS Greengrass API ReferenceCreateResourceDefinitionVersionRequestBody

} }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ] }}

CreateResourceDefinitionRequestBody

in: body

Name: "description"=>"The name of the resource definition.","type"=>"string"

InitialVersion: "$ref"=>"#/definitions/ResourceDefinitionVersion","description"=>"Information about the initial version of the resourcedefinition."

CreateResourceDefinitionVersionRequestBody{ "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" }

}, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ]}

CreateResourceDefinitionVersionRequestBody

in: body

required: true

schema: ResourceDefinitionVersion (p. 515)ResourceDefinitionVersion

type: array

type: object

The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128characters with pattern [a‑zA‑Z0‑9:_‑]+. This must be unique within a Greengrass group.

type: stringName

The descriptive resource name, which is displayed on the AWS Greengrass console. Max length 128characters with pattern [a‑zA‑Z0‑9:_‑]+. This must be unique within a Greengrass group.

type: object

The local absolute path of the device resource. The source path for a device resource can refer onlyto a character device or block device under /dev.

If true, AWS Greengrass automatically adds the specified Linux OS group owner of the resource tothe Lambda process privileges. Thus the Lambda process will have the file access permissions of theadded Linux group.

The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.

The local absolute path of the volume resource on the host. The source path for a volume resourcetype cannot start with /proc or /sys.

AWS Greengrass API ReferenceCreateSoftwareUpdateJobRequestBody

type: objectS3Uri

The URI of the source model in an Amazon S3 bucket. The model package must be in tar.gz or .zipformat.

type: string

CreateSoftwareUpdateJobRequestBody{ "UpdateTargetsArchitecture": "armv7l|x86_64|aarch64", "UpdateTargets": [ "string" ], "SoftwareToUpdate": "core|ota_agent", "S3UrlSignerRole": "string", "UpdateAgentLogLevel": "NONE|TRACE|DEBUG|VERBOSE|INFO|WARN|ERROR|FATAL", "UpdateTargetsOperatingSystem": "ubuntu|raspbian|amazon_linux"}

CreateSoftwareUpdateJobRequestBody

in: body

required: true

AWS Greengrass API ReferenceCreateSubscriptionDefinitionRequestBody

schema: CreateSoftwareUpdateJobRequest (p. 463)CreateSoftwareUpdateJobRequest

type: object

required: ["UpdateTargetsArchitecture", "UpdateTargets", "SoftwareToUpdate", "S3UrlSignerRole","UpdateTargetsOperatingSystem"]

type: string

The minimum level of log statements that should be logged by the OTA Agent during an update.

type: string

CreateSubscriptionDefinitionRequestBody{ "Name": "string", "InitialVersion": { "Subscriptions": [ { "Id": "string", "Source": "string",

AWS Greengrass API ReferenceCreateSubscriptionDefinitionVersionRequestBody

"Subject": "string", "Target": "string" } ] }}

CreateSubscriptionDefinitionRequestBody

in: body

Name: "description"=>"The name of the subscription definition.","type"=>"string"

InitialVersion: "$ref"=>"#/definitions/SubscriptionDefinitionVersion","description"=>"Information about the initial version of the subscriptiondefinition."

CreateSubscriptionDefinitionVersionRequestBody{ "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ]}

CreateSubscriptionDefinitionVersionRequestBody

in: body

required: true

schema: SubscriptionDefinitionVersion (p. 520)SubscriptionDefinitionVersion

type: array

type: object

AWS Greengrass API ReferenceDeploymentId

A descriptive or arbitrary ID for the subscription. This value must be unique within the subscriptiondefinition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.

type: stringSource

type: stringSubject

type: stringTarget

Where the message is sent to. Can be a thing ARN, a Lambda function ARN, 'cloud' (which representsthe AWS IoT cloud), or 'GGShadowService'.

type: string

DeploymentId{ "DeploymentId": "string"}

DeploymentId

in: path

required: true

type: string

DeviceDefinitionId{ "DeviceDefinitionId": "string"}

DeviceDefinitionId

in: path

required: true

type: string

AWS Greengrass API ReferenceDeviceDefinitionVersionId

DeviceDefinitionVersionId{ "DeviceDefinitionVersionId": "string"}

DeviceDefinitionVersionId

in: path

required: true

type: string

FunctionDefinitionId{ "FunctionDefinitionId": "string"}

FunctionDefinitionId

in: path

required: true

type: string

FunctionDefinitionVersionId{ "FunctionDefinitionVersionId": "string"}

FunctionDefinitionVersionId

in: path

required: true

type: string

GroupId{ "GroupId": "string"

AWS Greengrass API ReferenceGroupVersionId

GroupId

in: path

required: true

type: string

GroupVersionId{ "GroupVersionId": "string"}

GroupVersionId

in: path

required: true

type: string

LoggerDefinitionId{ "LoggerDefinitionId": "string"}

LoggerDefinitionId

in: path

required: true

type: string

LoggerDefinitionVersionId{ "LoggerDefinitionVersionId": "string"}

LoggerDefinitionVersionId

AWS Greengrass API ReferenceMaxResults

in: path

required: true

type: string

MaxResults{ "MaxResults": 100}

MaxResults

in: query

required: false

min: 1

max: 250

default: 250

type: integer

NextToken{ "NextToken": "string"}

NextToken

in: query

required: false

type: string

ResetDeploymentsRequestBody{ "Force": true}

ResetDeploymentsRequestBody

AWS Greengrass API ReferenceResourceDefinitionId

in: body

required: true

schema: ResetDeploymentsRequest (p. 509)ResetDeploymentsRequest

type: objectForce

type: boolean

ResourceDefinitionId{ "ResourceDefinitionId": "string"}

ResourceDefinitionId

in: path

required: true

type: string

ResourceDefinitionVersionId{ "ResourceDefinitionVersionId": "string"}

ResourceDefinitionVersionId

in: path

required: true

type: string

SubscriptionDefinitionId{ "SubscriptionDefinitionId": "string"}

AWS Greengrass API ReferenceSubscriptionDefinitionVersionId

SubscriptionDefinitionId

in: path

required: true

type: string

SubscriptionDefinitionVersionId{ "SubscriptionDefinitionVersionId": "string"}

SubscriptionDefinitionVersionId

in: path

required: true

type: string

ThingName{ "ThingName": "string"}

ThingName

The thing name.

in: path

required: true

type: string

UpdateConnectivityInfoRequestBody{ "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": 0x01, "Metadata": "string" } ]}

AWS Greengrass API ReferenceUpdateDefinitionRequestBody

UpdateConnectivityInfoRequestBody

in: body

schema: UpdateConnectivityInfoRequest (p. 521)

type: array

type: integer

type: string

UpdateDefinitionRequestBody{ "Name": "string"}

UpdateDefinitionRequestBody

in: body

Name: "description"=>"The name of the definition.", "required"=>true,"type"=>"string"

AWS Greengrass API ReferenceUpdateGroupCertificateConfigurationRequestBody

UpdateGroupCertificateConfigurationRequestBody{ "CertificateExpiryInMilliseconds": "string"}

UpdateGroupCertificateConfigurationRequestBody

in: body

required: true

schema: UpdateGroupCertificateConfigurationRequest (p. 525)

type: object

required: ["CertificateExpiryInMilliseconds"]

CertificateExpiryInMilliseconds

type: string

X-Amzn-Client-Token{ "X-Amzn-Client-Token": "string"}

X-Amzn-Client-Token

in: header

type: string

required: false

DefinitionsThe following definitions are used:

• AssociateRoleToGroupRequest (p. 458)

• AssociateServiceRoleToAccountRequest (p. 459)

• AssociateServiceRoleToAccountResponse (p. 459)

• ConnectivityInfo (p. 459)

• Core (p. 460)

• CoreDefinitionVersion (p. 460)

• CreateDeploymentRequest (p. 461)

AWS Greengrass API ReferenceDefinitions

• CreateDeploymentResponse (p. 462)

• CreateGroupCertificateAuthorityResponse (p. 462)

• CreateSoftwareUpdateJobRequest (p. 463)

• CreateSoftwareUpdateJobResponse (p. 464)

• DefinitionInformation (p. 464)

• Deployment (p. 465)

• DeploymentType (p. 466)

• Deployments (p. 466)

• Device (p. 467)

• DeviceDefinitionVersion (p. 467)

• DisassociateRoleFromGroupResponse (p. 468)

• DisassociateServiceRoleFromAccountResponse (p. 469)

• Empty Schema (p. 469)

• ErrorDetail (p. 469)

• ErrorDetails (p. 470)

• Function (p. 470)

• FunctionConfiguration (p. 472)

• FunctionConfigurationEnvironment (p. 474)

• FunctionDefinitionVersion (p. 475)

• GeneralError (p. 478)

• GetAssociatedRoleResponse (p. 479)

• GetConnectivityInfoResponse (p. 479)

• GetCoreDefinitionVersionResponse (p. 480)

• GetDeploymentStatusResponse (p. 481)

• GetDeviceDefinitionVersionResponse (p. 483)

• GetFunctionDefinitionVersionResponse (p. 484)

• GetGroupCertificateAuthorityResponse (p. 487)

• GetGroupVersionResponse (p. 487)

• GetLoggerDefinitionVersionResponse (p. 489)

• GetResourceDefinitionVersionResponse (p. 490)

• GetServiceRoleForAccountResponse (p. 494)

• GetSubscriptionDefinitionVersionResponse (p. 494)

• Group (p. 496)

• Group Certificate Authority Properties (p. 496)

• GroupCertificateConfiguration (p. 496)

• GroupInformation (p. 497)

• GroupOwnerSetting (p. 498)

• GroupVersion (p. 498)

• IDList (p. 499)

• ListDefinitionsResponse (p. 499)

• ListDeploymentsRequest (p. 501)

• ListDeploymentsResponse (p. 501)

• ListGroupCertificateAuthoritiesResponse (p. 502)

• ListGroupsResponse (p. 503)

AWS Greengrass API ReferenceAssociateRoleToGroupRequest

• ListVersionsResponse (p. 504)• LocalDeviceResourceData (p. 505)• LocalVolumeResourceData (p. 506)• Logger (p. 507)• LoggerComponent (p. 507)• LoggerDefinitionVersion (p. 508)• LoggerLevel (p. 509)• LoggerType (p. 509)• Permission (p. 509)• ResetDeploymentsRequest (p. 509)• ResetDeploymentsResponse (p. 510)• Resource (p. 510)• ResourceAccessPolicy (p. 513)• ResourceDataContainer (p. 513)• ResourceDefinitionVersion (p. 515)• S3MachineLearningModelResourceData (p. 518)• S3UrlSignerRole (p. 519)• SageMakerMachineLearningModelResourceData (p. 519)• SoftwareToUpdate (p. 519)• Subscription (p. 520)• SubscriptionDefinitionVersion (p. 520)• UpdateAgentLogLevel (p. 521)• UpdateConnectivityInfoRequest (p. 521)• UpdateConnectivityInfoResponse (p. 522)• UpdateTargets (p. 523)• UpdateTargetsArchitecture (p. 523)• UpdateTargetsOperatingSystem (p. 523)• VersionInformation (p. 523)• Versions (p. 524)• updateGroupCertificateConfigurationRequest (p. 525)

AssociateRoleToGroupRequest{ "RoleArn": "string"}

AssociateRoleToGroupRequest

type: object

type: string

AWS Greengrass API ReferenceAssociateServiceRoleToAccountRequest

AssociateServiceRoleToAccountRequest{ "RoleArn": "string"}

AssociateServiceRoleToAccountRequest

type: object

type: string

AssociateServiceRoleToAccountResponse{ "AssociatedAt": "string"}

type: string

ConnectivityInfo{ "Id": "string", "HostAddress": "string", "PortNumber": 0x01, "Metadata": "string"}

AWS Greengrass API ReferenceCore

type: integer

type: string

Core{ "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true}

type: object

type: boolean

CoreDefinitionVersion{

AWS Greengrass API ReferenceCreateDeploymentRequest

"Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}

CoreDefinitionVersion

type: objectCores

type: array

type: object

type: boolean

CreateDeploymentRequest{ "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string"

AWS Greengrass API ReferenceCreateDeploymentResponse

CreateDeploymentRequest

type: object

type: string

CreateDeploymentResponse{ "DeploymentArn": "string", "DeploymentId": "string"}

type: string

CreateGroupCertificateAuthorityResponse{ "GroupCertificateAuthorityArn": "string"}

type: object

AWS Greengrass API ReferenceCreateSoftwareUpdateJobRequest

type: string

CreateSoftwareUpdateJobRequest{ "UpdateTargetsArchitecture": "armv7l|x86_64|aarch64", "UpdateTargets": [ "string" ], "SoftwareToUpdate": "core|ota_agent", "S3UrlSignerRole": "string", "UpdateAgentLogLevel": "NONE|TRACE|DEBUG|VERBOSE|INFO|WARN|ERROR|FATAL", "UpdateTargetsOperatingSystem": "ubuntu|raspbian|amazon_linux"}

CreateSoftwareUpdateJobRequest

type: object

required: ["UpdateTargetsArchitecture", "UpdateTargets", "SoftwareToUpdate", "S3UrlSignerRole","UpdateTargetsOperatingSystem"]

type: string

AWS Greengrass API ReferenceCreateSoftwareUpdateJobResponse

type: string

CreateSoftwareUpdateJobResponse{ "IotJobId": "string", "IotJobArn": "string"}

type: string

DefinitionInformation{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string"}

type: objectName

type: stringId

AWS Greengrass API ReferenceDeployment

type: stringArn

type: string

Deployment{ "GroupArn": "string", "DeploymentId": "string", "DeploymentArn": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "CreatedAt": "string"}

Deployment

type: string

AWS Greengrass API ReferenceDeploymentType

DeploymentType

type: string

DeploymentType{}

type: string

Deployments[ { "GroupArn": "string", "DeploymentId": "string", "DeploymentArn": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "CreatedAt": "string" }]

type: array

AWS Greengrass API ReferenceDevice

type: string

Device{ "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true}

Device

type: object

type: boolean

DeviceDefinitionVersion{ "Devices": [ { "Id": "string",

AWS Greengrass API ReferenceDisassociateRoleFromGroupResponse

"ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}

type: objectDevices

type: array

type: object

type: boolean

DisassociateRoleFromGroupResponse{ "DisassociatedAt": "string"}

type: object

AWS Greengrass API ReferenceDisassociateServiceRoleFromAccountResponse

DisassociatedAt

type: string

DisassociateServiceRoleFromAccountResponse{ "DisassociatedAt": "string"}

type: string

Empty Schema{}

Empty Schema

type: object

ErrorDetail{ "DetailedErrorCode": "string", "DetailedErrorMessage": "string"}

ErrorDetail

AWS Greengrass API ReferenceErrorDetails

type: string

ErrorDetails[ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" }]

ErrorDetails

type: array

type: string

Function{ "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0, "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" }

AWS Greengrass API ReferenceFunction

], "AccessSysfs": true } }}

type: object

required: ["Id"]Id

type: objectPinned

AWS Greengrass API ReferenceFunctionConfiguration

type: string

type: object

type: array

type: object

type: string

type: boolean

FunctionConfiguration{ "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0,

AWS Greengrass API ReferenceFunctionConfiguration

"EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true }}

type: objectPinned

type: string

type: object

AWS Greengrass API ReferenceFunctionConfigurationEnvironment

Variables

type: object

type: array

type: object

type: string

type: boolean

FunctionConfigurationEnvironment{ "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true}

AWS Greengrass API ReferenceFunctionDefinitionVersion

type: object

type: array

type: object

type: string

type: boolean

FunctionDefinitionVersion{ "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0,

"EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ]}

FunctionDefinitionVersion

type: array

type: object

required: ["Id"]Id

type: objectPinned

type: boolean

Executable

type: string

type: object

type: array

type: object

AWS Greengrass API ReferenceGeneralError

type: string

Permission

type: string

enum: ["ro", "rw"]

AccessSysfs

type: boolean

GeneralError{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}

GeneralError

type: object

Message

type: string

ErrorDetails

type: array

ErrorDetail

type: object

DetailedErrorCode

type: string

AWS Greengrass API ReferenceGetAssociatedRoleResponse

type: string

GetAssociatedRoleResponse{ "AssociatedAt": "string", "RoleArn": "string"}

type: stringRoleArn

type: string

GetConnectivityInfoResponse{ "message": "string", "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": 0x01, "Metadata": "string" } ]}

type: array

AWS Greengrass API ReferenceGetCoreDefinitionVersionResponse

type: integer

type: string

GetCoreDefinitionVersionResponse{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}

type: objectArn

type: stringId

AWS Greengrass API ReferenceGetDeploymentStatusResponse

type: stringVersion

type: objectCores

type: array

type: object

type: boolean

GetDeploymentStatusResponse{ "DeploymentStatus": "string",

AWS Greengrass API ReferenceGetDeploymentStatusResponse

"DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "UpdatedAt": "string", "ErrorMessage": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}

type: objectDeploymentStatus

type: string

enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]UpdatedAt

type: stringErrorMessage

Error message

type: array

type: string

AWS Greengrass API ReferenceGetDeviceDefinitionVersionResponse

GetDeviceDefinitionVersionResponse{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}

type: objectArn

type: stringId

type: stringVersion

type: objectDevices

type: array

type: object

AWS Greengrass API ReferenceGetFunctionDefinitionVersionResponse

type: boolean

GetFunctionDefinitionVersionResponse{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0, "EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ] }

type: objectArn

type: stringId

type: stringVersion

type: array

type: object

required: ["Id"]Id

type: objectPinned

type: string

type: object

type: array

AWS Greengrass API ReferenceGetGroupCertificateAuthorityResponse

type: object

type: string

type: boolean

GetGroupCertificateAuthorityResponse{ "PemEncodedCertificate": "string", "GroupCertificateAuthorityArn": "string", "GroupCertificateAuthorityId": "string"}

type: objectPemEncodedCertificate

type: stringGroupCertificateAuthorityId

type: string

GetGroupVersionResponse{

AWS Greengrass API ReferenceGetGroupVersionResponse

"Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string" }}

type: objectArn

type: stringId

type: stringVersion

type: string

AWS Greengrass API ReferenceGetLoggerDefinitionVersionResponse

SubscriptionDefinitionVersionArn

type: string

GetLoggerDefinitionVersionResponse{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ] }}

type: objectArn

type: stringId

type: stringVersion

AWS Greengrass API ReferenceGetResourceDefinitionVersionResponse

type: objectLoggers

A list of loggers.

type: array

type: object

type: stringType

type: string

type: integer

GetResourceDefinitionVersionResponse{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Resources": [ { "Id": "string",

"Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ] }}

type: objectArn

type: stringId

type: stringVersion

type: object

Resources

type: array

type: object

type: stringName

type: object

type: boolean

GroupOwner

type: object

AWS Greengrass API ReferenceGetServiceRoleForAccountResponse

type: string

GetServiceRoleForAccountResponse{ "AssociatedAt": "string", "RoleArn": "string"}

type: stringRoleArn

type: string

GetSubscriptionDefinitionVersionResponse{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }}

type: object

AWS Greengrass API ReferenceGetSubscriptionDefinitionVersionResponse

type: stringId

type: stringVersion

type: array

type: object

type: stringSource

type: stringSubject

type: stringTarget

AWS Greengrass API ReferenceGroup

type: string

Group{ "AssociatedAt": "string"}

type: string

Group Certificate Authority Properties{ "GroupCertificateAuthorityId": "string", "GroupCertificateAuthorityArn": "string"}

Group Certificate Authority Properties

type: string

GroupCertificateConfiguration{ "GroupId": "string", "CertificateAuthorityExpiryInMilliseconds": "string", "CertificateExpiryInMilliseconds": "string"}

type: object

AWS Greengrass API ReferenceGroupInformation

GroupId

type: string

GroupInformation{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string"}

GroupInformation

type: objectName

type: stringId

type: stringArn

type: string

AWS Greengrass API ReferenceGroupOwnerSetting

LatestVersion

type: string

GroupOwnerSetting{ "AutoAddGroupOwner": true, "GroupOwner": "string"}

GroupOwnerSetting

type: string

GroupVersion{ "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string"}

GroupVersion

AWS Greengrass API ReferenceIDList

type: string

IDList{ "Ids": [ "string" ]}

IDList

type: objectIds

A list of IDs.

type: array

ListDefinitionsResponse{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string",

AWS Greengrass API ReferenceListDefinitionsResponse

"LatestVersionArn": "string" } ], "NextToken": "string"}

type: array

type: objectName

type: stringId

type: stringArn

type: string

AWS Greengrass API ReferenceListDeploymentsRequest

NextToken

type: string

ListDeploymentsRequest{ "MaxResults": 0, "NextToken": "string"}

ListDeploymentsRequest

type: objectMaxResults

in: query

type: integer

min: 1

max: 250NextToken

The token to retrieve the next set of results.

in: query

type: string

ListDeploymentsResponse{ "Deployments": [ { "GroupArn": "string", "DeploymentId": "string", "DeploymentArn": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "CreatedAt": "string" } ], "NextToken": "string"}

type: array

AWS Greengrass API ReferenceListGroupCertificateAuthoritiesResponse

type: string

in: query

type: string

ListGroupCertificateAuthoritiesResponse{ "GroupCertificateAuthorities": [ { "GroupCertificateAuthorityId": "string", "GroupCertificateAuthorityArn": "string" } ]}

type: array

AWS Greengrass API ReferenceListGroupsResponse

type: string

ListGroupsResponse{ "Groups": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}

ListGroupsResponse

type: objectGroups

type: array

items: GroupInformation (p. 497)GroupInformation

type: objectName

type: stringId

AWS Greengrass API ReferenceListVersionsResponse

type: stringArn

type: string

ListVersionsResponse{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}

A list of versions.

type: array

items: VersionInformation (p. 523)

AWS Greengrass API ReferenceLocalDeviceResourceData

VersionInformation

type: objectArn

type: stringId

type: stringVersion

type: string

LocalDeviceResourceData{ "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" }}

LocalDeviceResourceData

type: object

AWS Greengrass API ReferenceLocalVolumeResourceData

AutoAddGroupOwner

type: string

LocalVolumeResourceData{ "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" }}

LocalVolumeResourceData

AWS Greengrass API ReferenceLogger

type: string

Logger{ "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0}

Logger

type: object

type: stringType

type: string

type: integer

LoggerComponent{}

type: string

enum: ["GreengrassSystem", "Lambda"]

AWS Greengrass API ReferenceLoggerDefinitionVersion

LoggerDefinitionVersion{ "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ]}

type: objectLoggers

A list of loggers.

type: array

type: object

type: stringType

type: string

AWS Greengrass API ReferenceLoggerLevel

type: integer

LoggerLevel{}

type: string

enum: ["DEBUG", "INFO", "WARN", "ERROR", "FATAL"]

LoggerType{}

type: string

enum: ["FileSystem", "AWSCloudWatch"]

Permission{}

type: string

enum: ["ro", "rw"]

ResetDeploymentsRequest{ "Force": true}

ResetDeploymentsRequest

type: objectForce

type: boolean

AWS Greengrass API ReferenceResetDeploymentsResponse

ResetDeploymentsResponse{ "DeploymentArn": "string", "DeploymentId": "string"}

type: string

Resource{ "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } }}

Resource

type: object

AWS Greengrass API ReferenceResource

type: stringName

type: object

AWS Greengrass API ReferenceResource

SourcePath

type: objectS3Uri

AWS Greengrass API ReferenceResourceAccessPolicy

type: string

ResourceAccessPolicy{ "ResourceId": "string", "Permission": "ro|rw"}

type: object

type: string

enum: ["ro", "rw"]

ResourceDataContainer{ "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" }}

AWS Greengrass API ReferenceResourceDataContainer

type: object

AWS Greengrass API ReferenceResourceDefinitionVersion

AutoAddGroupOwner

type: objectS3Uri

type: string

ResourceDefinitionVersion{ "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true,

"GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ]}

ResourceDefinitionVersion

type: array

type: object

type: stringName

type: object

AWS Greengrass API ReferenceS3MachineLearningModelResourceData

type: objectS3Uri

type: string

S3MachineLearningModelResourceData{ "S3Uri": "string", "DestinationPath": "string"}

S3MachineLearningModelResourceData

type: objectS3Uri

AWS Greengrass API ReferenceS3UrlSignerRole

type: string

S3UrlSignerRole{}

type: string

SageMakerMachineLearningModelResourceData{ "SageMakerJobArn": "string", "DestinationPath": "string"}

SageMakerMachineLearningModelResourceData

type: string

SoftwareToUpdate{}

type: string

enum: ["core", "ota_agent"]

AWS Greengrass API ReferenceSubscription

Subscription{ "Id": "string", "Source": "string", "Subject": "string", "Target": "string"}

Subscription

type: object

type: stringSource

type: stringSubject

type: stringTarget

type: string

SubscriptionDefinitionVersion{ "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ]}

SubscriptionDefinitionVersion

AWS Greengrass API ReferenceUpdateAgentLogLevel

type: array

type: object

type: stringSource

type: stringSubject

type: stringTarget

type: string

UpdateAgentLogLevel{}

type: string

enum: ["NONE", "TRACE", "DEBUG", "VERBOSE", "INFO", "WARN", "ERROR", "FATAL"]

UpdateConnectivityInfoRequest{ "ConnectivityInfo": [

AWS Greengrass API ReferenceUpdateConnectivityInfoResponse

{ "Id": "string", "HostAddress": "string", "PortNumber": 0x01, "Metadata": "string" } ]}

type: array

type: integer

type: string

UpdateConnectivityInfoResponse{ "message": "string", "Version": "string"}

message

type: string

AWS Greengrass API ReferenceUpdateTargets

Version

type: string

UpdateTargets{}

type: array

UpdateTargetsArchitecture{}

type: string

enum: ["armv7l", "x86_64", "aarch64"]

UpdateTargetsOperatingSystem{}

type: string

VersionInformation{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string"}

VersionInformation

AWS Greengrass API ReferenceVersions

type: objectArn

type: stringId

type: stringVersion

type: string

Versions{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ]}

Versions

A list of versions.

type: array

type: objectArn

type: stringId

AWS Greengrass API ReferenceupdateGroupCertificateConfigurationRequest

type: stringVersion

type: string

updateGroupCertificateConfigurationRequest{ "CertificateExpiryInMilliseconds": "string"}

type: object

type: string

AWS Greengrass - API Reference Greengrass API Reference ListDeviceDeﬁnitions 160...

Documents

API Reference - support.huaweicloud.com

Programming API Reference Guide - · PDF fileProgramming API Reference Guide vi VMware, Inc. Notes ... The Programming API Reference Guide describes an ... The Programming API runs

Amazon API Gateway - API Reference - docs.aws.amazon.com · AWS glossary..... 234 vi. Amazon API Gateway API Reference Amazon API Gateway Version 2 API Reference Welcome to the Amazon

Amazon Lightsail - API Reference · 2016-11-28 · Amazon Lightsail API Reference. Amazon Lightsail API Reference. Welcome The Lightsail API Reference describes the API actions, data

Oracledi API Reference

AWS IoT Greengrass - 開発者ガイド · AWS IoT Greengrass 開発者ガイド

Workflow API Reference

Amazon SES API v2 - API v2 Reference · Amazon SES API v2 API v2 Reference Response Syntax..... 22

EV10 API Reference

AWS Greengrass - Guide de l'utilisateur · AWS Greengrass Guide de l'utilisateur Versions de AWS Greengrass Core • Répertoire en écriture configurable. Le logiciel Noyau AWS Greengrass

Amazon Kinesis Firehose API Reference - API Reference

AWS IoT Greengrass · 2020-01-16 · AWS IoT Greengrass 개발자 안내서 별칭 또는 버전을 기준으로 함수 참조..... 195 Greengrass Lambda 함수 실행 제어

API Reference

URScript API Reference

AcroPDF API Reference

AWS Greengrass - Pusan National Universityinfosec.pusan.ac.kr/wp-content/uploads/2018/11/10.-AWS... · 2018-11-19 · AWS Greengrass GGC(Greengrass Core) –Device work together locally

Order Manager API Reference Guide - SDN · 2.3.21 TaxTotal ... This chapter contains the API reference. The Order Manager API Reference Guide ... The Order Manager API Reference Guide

PThread API Reference

Rational Rhapsody API Reference Manual - IBM€¦ · Rational Rhapsody API ... iv API Reference Manual ... 521 Callback API Introduction

AWS Elemental MediaConvert API Reference - API Reference · AWS Elemental MediaConvert API Reference API Reference CreateJob Example Using the AWS CLI • Python: CreateJob Example