AWS Greengrass API Reference
AWS GreengrassAPI Reference
AWS Greengrass API Reference
AWS Greengrass: API ReferenceCopyright © 2018 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
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.
AWS Greengrass API Reference
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
iii
AWS Greengrass API Reference
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
iv
AWS Greengrass API Reference
/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
v
AWS Greengrass API Reference
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
vi
AWS Greengrass API Reference
ResourceDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515S3MachineLearningModelResourceData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518S3UrlSignerRole .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519SageMakerMachineLearningModelResourceData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519SoftwareToUpdate .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519Subscription .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520SubscriptionDefinitionVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520UpdateAgentLogLevel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521UpdateConnectivityInfoRequest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521UpdateConnectivityInfoResponse .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522UpdateTargets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523UpdateTargetsArchitecture .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523UpdateTargetsOperatingSystem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523VersionInformation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523Versions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524updateGroupCertificateConfigurationRequest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
vii
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)
1
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)
2
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
CLI:
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
3
AWS Greengrass API ReferenceAssociateRoleToGroup
Responses:200
success
AssociateRoleToGroupResponse (p. 496)
{ "AssociatedAt": "string"}
Group
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.
4
AWS Greengrass API ReferenceAssociateRoleToGroup
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string500
server error
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.
5
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
CLI:
aws greengrass associate-service-role-to-account \ [--role-arn <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "RoleArn": "string"}
Parameters:AssociateServiceRoleToAccountRequestBody (p. 431)
where used: body; required: true
{ "RoleArn": "string"}
schema:AssociateServiceRoleToAccountRequest
type: object
required: ["RoleArn"]RoleArn
The ARN of the service role you wish to associate with your account.
type: string
Responses:200
success
AssociateServiceRoleToAccountResponse (p. 459)
{
6
AWS Greengrass API ReferenceAssociateServiceRoleToAccount
"AssociatedAt": "string"}
AssociateServiceRoleToAccountResponse
type: objectAssociatedAt
The time when the service role was associated with the account.
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.
7
AWS Greengrass API ReferenceCreateCoreDefinition
type: string500
server error
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: 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
8
AWS Greengrass API ReferenceCreateCoreDefinition
Produces: application/json
CLI:
aws greengrass create-core-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "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.
where used: body; required: true
{ "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.
9
AWS Greengrass API ReferenceCreateCoreDefinition
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",
10
AWS Greengrass API ReferenceCreateCoreDefinition
"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
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
11
AWS Greengrass API ReferenceCreateCoreDefinitionVersion
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: 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
Produces: application/json
CLI:
aws greengrass create-core-definition-version \ --core-definition-id <value> \ [--cores <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "CoreDefinitionId": "string",
12
AWS Greengrass API ReferenceCreateCoreDefinitionVersion
"Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ], "AmznClientToken": "string"}
Parameters:CoreDefinitionId (p. 431)
The ID of the core definition.
where used: path; required: true
type: stringCreateCoreDefinitionVersionRequestBody (p. 432)
where used: body; required: true
{ "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}
schema:CoreDefinitionVersion
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:_-]+.
13
AWS Greengrass API ReferenceCreateCoreDefinitionVersion
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 (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
14
AWS Greengrass API ReferenceCreateDeployment
CreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
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: string
CreateDeploymentCreates a deployment.
15
AWS Greengrass API ReferenceCreateDeployment
URI: POST /greengrass/groups/GroupId/deployments
Produces: application/json
CLI:
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]
cli-input-json format:
{ "GroupId": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string", "AmznClientToken": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: stringCreateDeploymentRequestBody (p. 433)
where used: body; required: true
{ "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"]
16
AWS Greengrass API ReferenceCreateDeployment
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)
A client token used to correlate requests and responses.
where used: header; required: false
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
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]
17
AWS Greengrass API ReferenceCreateDeviceDefinition
}
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: 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
Produces: application/json
CLI:
aws greengrass create-device-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
18
AWS Greengrass API ReferenceCreateDeviceDefinition
{ "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.
where used: body; required: true
{ "Name": "string", "InitialVersion": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}
schema:Name
The name of the device definition.
type: stringInitialVersion
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
19
AWS Greengrass API ReferenceCreateDeviceDefinition
required: ["Id", "ThingArn", "CertificateArn"]Id
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:_-]+.
type: stringThingArn
The thing ARN of the device.
type: stringCertificateArn
The ARN of the certificate associated with the device.
type: stringSyncShadow
If true, the device's local shadow will be 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 (CreateDeviceDefinitionResponse)
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.
20
AWS Greengrass API ReferenceCreateDeviceDefinition
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
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
21
AWS Greengrass API ReferenceCreateDeviceDefinitionVersion
items: ErrorDetail (p. 469)ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
CreateDeviceDefinitionVersionCreates a version of a device definition that has already been defined.
URI: POST /greengrass/definition/devices/DeviceDefinitionId/versions
Produces: application/json
CLI:
aws greengrass create-device-definition-version \ --device-definition-id <value> \ [--devices <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "DeviceDefinitionId": "string", "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ], "AmznClientToken": "string"}
Parameters:DeviceDefinitionId (p. 449)
The ID of the device definition.
where used: path; required: true
22
AWS Greengrass API ReferenceCreateDeviceDefinitionVersion
type: string
CreateDeviceDefinitionVersionRequestBody (p. 435)
where used: body; required: true
{ "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}
schema:
DeviceDefinitionVersion
Information about a device definition version.
type: object
Devices
A list of devices in the definition version.
type: array
items: Device (p. 467)
Device
Information about a device.
type: object
required: ["Id", "ThingArn", "CertificateArn"]
Id
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:_-]+.
type: string
ThingArn
The thing ARN of the device.
type: string
CertificateArn
The ARN of the certificate associated with the device.
type: string
SyncShadow
If true, the device's local shadow will be automatically synced with the cloud.
type: boolean
23
AWS Greengrass API ReferenceCreateDeviceDefinitionVersion
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:200 (CreateDeviceDefinitionVersionResponse)
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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: string400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string"
24
AWS Greengrass API ReferenceCreateFunctionDefinition
} ]}
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: 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
Produces: application/json
CLI:
aws greengrass create-function-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
25
AWS Greengrass API ReferenceCreateFunctionDefinition
cli-input-json format:
{ "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)
where used: body; required: true
{ "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" },
26
AWS Greengrass API ReferenceCreateFunctionDefinition
"ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ] }}
schema:Name
The name of the function definition.
type: stringInitialVersion
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
27
AWS Greengrass API ReferenceCreateFunctionDefinition
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.)
28
AWS Greengrass API ReferenceCreateFunctionDefinition
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: booleanX-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:200 (CreateFunctionDefinitionResponse)
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: string
29
AWS Greengrass API ReferenceCreateFunctionDefinition
LastUpdatedTimestamp
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
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: object
30
AWS Greengrass API ReferenceCreateFunctionDefinitionVersion
DetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
CreateFunctionDefinitionVersionCreates a version of a Lambda function definition that has already been defined.
URI: POST /greengrass/definition/functions/FunctionDefinitionId/versions
Produces: application/json
CLI:
aws greengrass create-function-definition-version \ --function-definition-id <value> \ [--functions <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "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" } } } ],
31
AWS Greengrass API ReferenceCreateFunctionDefinitionVersion
"AmznClientToken": "string"}
Parameters:FunctionDefinitionId (p. 450)
The ID of the Lambda function definition.
where used: path; required: true
type: stringCreateFunctionDefinitionVersionRequestBody (p. 437)
Information about the function definition version.
where used: body; required: true
{ "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
Information about a function definition version.
type: objectFunctions
A list of Lambda functions in this function definition version.
type: array
32
AWS Greengrass API ReferenceCreateFunctionDefinitionVersion
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: booleanExecutable
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"]
33
AWS Greengrass API ReferenceCreateFunctionDefinitionVersion
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: booleanX-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:200 (CreateFunctionDefinitionVersionResponse)
VersionInformation (p. 523)
34
AWS Greengrass API ReferenceCreateFunctionDefinitionVersion
{ "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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
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: string
35
AWS Greengrass API ReferenceCreateGroup
ErrorDetails
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: 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
Produces: application/json
CLI:
aws greengrass create-group \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "Name": "string", "InitialVersion": { "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string" }, "AmznClientToken": "string"
36
AWS Greengrass API ReferenceCreateGroup
}
Parameters:CreateGroupRequestBody (p. 439)
where used: body; required: true
{ "Name": "string", "InitialVersion": { "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string" }}
schema:Name
The name of the group.
type: stringInitialVersion
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.
37
AWS Greengrass API ReferenceCreateGroup
type: stringX-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:200 (CreateGroupResponse)
Success. The group was created.
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: string
38
AWS Greengrass API ReferenceCreateGroup
LatestVersion
The latest version of the definition.
type: stringLatestVersionArn
The ARN of the latest version of the definition.
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: string
39
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
Produces: application/json
CLI:
aws greengrass create-group-certificate-authority \ --group-id <value> \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "AmznClientToken": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: stringX-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:200
Success. The response body contains the new active CA ARN.
CreateGroupCertificateAuthorityResponse (p. 462)
{ "GroupCertificateAuthorityArn": "string"}
CreateGroupCertificateAuthorityResponse
type: object
40
AWS Greengrass API ReferenceCreateGroupCertificateAuthority
GroupCertificateAuthorityArn
The ARN of the group certificate authority.
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 (p. 478)
41
AWS Greengrass API ReferenceCreateGroupVersion
{ "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: string
CreateGroupVersionCreates a version of a group which has already been defined.
URI: POST /greengrass/groups/GroupId/versions
Produces: application/json
CLI:
aws greengrass create-group-version \ --group-id <value> \
42
AWS Greengrass API ReferenceCreateGroupVersion
[--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]
cli-input-json format:
{ "GroupId": "string", "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string", "AmznClientToken": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: stringCreateGroupVersionRequestBody (p. 440)
where used: body; required: true
{ "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string"}
schema:GroupVersion
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.
43
AWS Greengrass API ReferenceCreateGroupVersion
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: stringX-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:200 (CreateGroupVersionResponse)
Success. The response contains information about the group version.
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.
44
AWS Greengrass API ReferenceCreateGroupVersion
type: stringVersion
The unique ID of the version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
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.
45
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
Produces: application/json
CLI:
aws greengrass create-logger-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "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)
where used: body; required: true
{ "Name": "string", "InitialVersion": { "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ] }}
46
AWS Greengrass API ReferenceCreateLoggerDefinition
schema:Name
The name of the logger definition.
type: stringInitialVersion
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)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
47
AWS Greengrass API ReferenceCreateLoggerDefinition
Responses:200 (CreateLoggerDefinitionResponse)
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
48
AWS Greengrass API ReferenceCreateLoggerDefinitionVersion
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: string
CreateLoggerDefinitionVersionCreates a version of a logger definition that has already been defined.
URI: POST /greengrass/definition/loggers/LoggerDefinitionId/versions
Produces: application/json
CLI:
aws greengrass create-logger-definition-version \
49
AWS Greengrass API ReferenceCreateLoggerDefinitionVersion
--logger-definition-id <value> \ [--loggers <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "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.
where used: path; required: true
type: stringCreateLoggerDefinitionVersionRequestBody (p. 441)
where used: body; required: true
{ "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ]}
schema:LoggerDefinitionVersion
Information about a logger definition version.
type: objectLoggers
A list of loggers.
type: array
items: Logger (p. 507)
50
AWS Greengrass API ReferenceCreateLoggerDefinitionVersion
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)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:200 (CreateLoggerDefinitionVersionResponse)
VersionInformation (p. 523)
{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string"}
VersionInformation
Information about a version.
type: object
51
AWS Greengrass API ReferenceCreateLoggerDefinitionVersion
Arn
The ARN of the version.
type: stringId
The ID of the version.
type: stringVersion
The unique ID of the version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
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: object
52
AWS Greengrass API ReferenceCreateResourceDefinition
DetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
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
Produces: application/json
CLI:
aws greengrass create-resource-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "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"
53
AWS Greengrass API ReferenceCreateResourceDefinition
}, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ] }, "AmznClientToken": "string"}
Parameters:CreateResourceDefinitionRequestBody (p. 442)
where used: body; required: true
{ "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
54
AWS Greengrass API ReferenceCreateResourceDefinition
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
55
AWS Greengrass API ReferenceCreateResourceDefinition
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.
type: objectSourcePath
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: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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: 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
56
AWS Greengrass API ReferenceCreateResourceDefinition
DestinationPath
The absolute local path of the resource inside the Lambda environment.
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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: stringX-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:200 (CreateResourceDefinitionResponse)
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.
57
AWS Greengrass API ReferenceCreateResourceDefinition
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
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
58
AWS Greengrass API ReferenceCreateResourceDefinitionVersion
items: ErrorDetail (p. 469)ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
CreateResourceDefinitionVersionCreates a version of a resource definition that has already been defined.
URI: POST /greengrass/definition/resources/ResourceDefinitionId/versions
Produces: application/json
CLI:
aws greengrass create-resource-definition-version \ --resource-definition-id <value> \ [--resources <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "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" }
59
AWS Greengrass API ReferenceCreateResourceDefinitionVersion
}, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ], "AmznClientToken": "string"}
Parameters:ResourceDefinitionId (p. 453)
The ID of the resource definition.
where used: path; required: true
type: stringCreateResourceDefinitionVersionRequestBody (p. 443)
Information about the resource definition version.
where used: body; required: true
{ "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" } } } ]
60
AWS Greengrass API ReferenceCreateResourceDefinitionVersion
}
schema:ResourceDefinitionVersion
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: string
61
AWS Greengrass API ReferenceCreateResourceDefinitionVersion
GroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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.
type: objectSourcePath
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: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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: 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.
62
AWS Greengrass API ReferenceCreateResourceDefinitionVersion
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: stringX-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:200 (CreateResourceDefinitionVersionResponse)
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: string
63
AWS Greengrass API ReferenceCreateResourceDefinitionVersion
Version
The unique ID of the version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
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: string
64
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
Produces: application/json
CLI:
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]
cli-input-json format:
{ "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)
where used: body; required: true
{ "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.
65
AWS Greengrass API ReferenceCreateSoftwareUpdateJob
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)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:200
success
CreateSoftwareUpdateJobResponse (p. 464)
66
AWS Greengrass API ReferenceCreateSoftwareUpdateJob
{ "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 (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: object
67
AWS Greengrass API ReferenceCreateSoftwareUpdateJob
DetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string500
server error
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: string
68
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
Produces: application/json
CLI:
aws greengrass create-subscription-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "Name": "string", "InitialVersion": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }, "AmznClientToken": "string"}
Parameters:CreateSubscriptionDefinitionRequestBody (p. 447)
where used: body; required: true
{ "Name": "string", "InitialVersion": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }}
schema:Name
The name of the subscription definition.
69
AWS Greengrass API ReferenceCreateSubscriptionDefinition
type: stringInitialVersion
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: stringX-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:200 (CreateSubscriptionDefinitionResponse)
DefinitionInformation (p. 464)
{
70
AWS Greengrass API ReferenceCreateSubscriptionDefinition
"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
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ {
71
AWS Greengrass API ReferenceCreateSubscriptionDefinitionVersion
"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: string
CreateSubscriptionDefinitionVersionCreates a version of a subscription definition which has already been defined.
URI: POST /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions
Produces: application/json
CLI:
aws greengrass create-subscription-definition-version \ --subscription-definition-id <value> \ [--subscriptions <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
72
AWS Greengrass API ReferenceCreateSubscriptionDefinitionVersion
cli-input-json format:
{ "SubscriptionDefinitionId": "string", "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ], "AmznClientToken": "string"}
Parameters:SubscriptionDefinitionId (p. 453)
The ID of the subscription definition.
where used: path; required: true
type: stringCreateSubscriptionDefinitionVersionRequestBody (p. 448)
where used: body; required: true
{ "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ]}
schema:SubscriptionDefinitionVersion
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"]
73
AWS Greengrass API ReferenceCreateSubscriptionDefinitionVersion
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: stringX-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:200 (CreateSubscriptionDefinitionVersionResponse)
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.
74
AWS Greengrass API ReferenceCreateSubscriptionDefinitionVersion
type: stringVersion
The unique ID of the version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
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.
75
AWS Greengrass API ReferenceDeleteCoreDefinition
type: string
DeleteCoreDefinitionDeletes a core definition.
URI: DELETE /greengrass/definition/cores/CoreDefinitionId
Produces: application/json
CLI:
aws greengrass delete-core-definition \ --core-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "CoreDefinitionId": "string"}
Parameters:CoreDefinitionId (p. 431)
The ID of the core definition.
where used: path; required: true
type: string
Responses:200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
invalid request
GeneralError (p. 478)
76
AWS Greengrass API ReferenceDeleteDeviceDefinition
{ "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: string
DeleteDeviceDefinitionDeletes a device definition.
URI: DELETE /greengrass/definition/devices/DeviceDefinitionId
Produces: application/json
CLI:
aws greengrass delete-device-definition \
77
AWS Greengrass API ReferenceDeleteDeviceDefinition
--device-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "DeviceDefinitionId": "string"}
Parameters:DeviceDefinitionId (p. 449)
The ID of the device definition.
where used: path; required: true
type: string
Responses:200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
78
AWS Greengrass API ReferenceDeleteFunctionDefinition
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: string
DeleteFunctionDefinitionDeletes a Lambda function definition.
URI: DELETE /greengrass/definition/functions/FunctionDefinitionId
Produces: application/json
CLI:
aws greengrass delete-function-definition \ --function-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "FunctionDefinitionId": "string"}
Parameters:FunctionDefinitionId (p. 450)
The ID of the Lambda function definition.
79
AWS Greengrass API ReferenceDeleteFunctionDefinition
where used: path; required: true
type: string
Responses:200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
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.
80
AWS Greengrass API ReferenceDeleteGroup
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
DeleteGroupDeletes a group.
URI: DELETE /greengrass/groups/GroupId
Produces: application/json
CLI:
aws greengrass delete-group \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
Responses:200
success
Empty (p. 469)
{}
81
AWS Greengrass API ReferenceDeleteLoggerDefinition
Empty Schema
Empty
type: object400
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: string
DeleteLoggerDefinitionDeletes a logger definition.
82
AWS Greengrass API ReferenceDeleteLoggerDefinition
URI: DELETE /greengrass/definition/loggers/LoggerDefinitionId
Produces: application/json
CLI:
aws greengrass delete-logger-definition \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "LoggerDefinitionId": "string"}
Parameters:LoggerDefinitionId (p. 451)
The ID of the logger definition.
where used: path; required: true
type: string
Responses:200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]
83
AWS Greengrass API ReferenceDeleteResourceDefinition
}
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: string
DeleteResourceDefinitionDeletes a resource definition.
URI: DELETE /greengrass/definition/resources/ResourceDefinitionId
Produces: application/json
CLI:
aws greengrass delete-resource-definition \ --resource-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ResourceDefinitionId": "string"}
84
AWS Greengrass API ReferenceDeleteResourceDefinition
Parameters:ResourceDefinitionId (p. 453)
The ID of the resource definition.
where used: path; required: true
type: string
Responses:200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
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.
85
AWS Greengrass API ReferenceDeleteSubscriptionDefinition
type: array
items: ErrorDetail (p. 469)ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
DeleteSubscriptionDefinitionDeletes a subscription definition.
URI: DELETE /greengrass/definition/subscriptions/SubscriptionDefinitionId
Produces: application/json
CLI:
aws greengrass delete-subscription-definition \ --subscription-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string"}
Parameters:SubscriptionDefinitionId (p. 453)
The ID of the subscription definition.
where used: path; required: true
type: string
Responses:200
success
86
AWS Greengrass API ReferenceDeleteSubscriptionDefinition
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
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: string
87
AWS Greengrass API ReferenceDisassociateRoleFromGroup
DisassociateRoleFromGroupDisassociates the role from a group.
URI: DELETE /greengrass/groups/GroupId/role
CLI:
aws greengrass disassociate-role-from-group \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
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
GeneralError (p. 478)
88
AWS Greengrass API ReferenceDisassociateRoleFromGroup
{ "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 (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
89
AWS Greengrass API ReferenceDisassociateServiceRoleFromAccount
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: string
DisassociateServiceRoleFromAccountDisassociates the service role from your account. Without a service role, deployments will not work.
URI: DELETE /greengrass/servicerole
CLI:
aws greengrass disassociate-service-role-from-account \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
Responses:200
success
DisassociateServiceRoleFromAccountResponse (p. 469)
{
90
AWS Greengrass API ReferenceDisassociateServiceRoleFromAccount
"DisassociatedAt": "string"}
DisassociateServiceRoleFromAccountResponse
type: objectDisassociatedAt
The time when the service role was disassociated from the account.
type: string500
server error
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.
91
AWS Greengrass API ReferenceGetAssociatedRole
type: string
GetAssociatedRoleRetrieves the role associated with a particular group.
URI: GET /greengrass/groups/GroupId/role
CLI:
aws greengrass get-associated-role \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
Responses:200
success
GetAssociatedRoleResponse (p. 479)
{ "AssociatedAt": "string", "RoleArn": "string"}
GetAssociatedRoleResponse
type: objectAssociatedAt
The time when the role was associated with the group.
type: stringRoleArn
The ARN of the role that is associated with the group.
92
AWS Greengrass API ReferenceGetAssociatedRole
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 (p. 478)
{ "Message": "string",
93
AWS Greengrass API ReferenceGetConnectivityInfo
"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: string
GetConnectivityInfoRetrieves the connectivity information for a core.
URI: GET /greengrass/things/ThingName/connectivityInfo
Produces: application/json
CLI:
aws greengrass get-connectivity-info \ --thing-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
94
AWS Greengrass API ReferenceGetConnectivityInfo
cli-input-json format:
{ "ThingName": "string"}
Parameters:ThingName (p. 454)
The thing name.
where used: path; required: true
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.
95
AWS Greengrass API ReferenceGetConnectivityInfo
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 (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: object
96
AWS Greengrass API ReferenceGetConnectivityInfo
DetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string500
server error
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: string
97
AWS Greengrass API ReferenceGetCoreDefinition
GetCoreDefinitionRetrieves information about a core definition version.
URI: GET /greengrass/definition/cores/CoreDefinitionId
Produces: application/json
CLI:
aws greengrass get-core-definition \ --core-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "CoreDefinitionId": "string"}
Parameters:CoreDefinitionId (p. 431)
The ID of the core definition.
where used: path; required: true
type: string
Responses:200 (GetCoreDefinitionResponse)
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.
98
AWS Greengrass API ReferenceGetCoreDefinition
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
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: string
99
AWS Greengrass API ReferenceGetCoreDefinitionVersion
ErrorDetails
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: string
GetCoreDefinitionVersionRetrieves information about a core definition version.
URI: GET /greengrass/definition/cores/CoreDefinitionId/versions/CoreDefinitionVersionId
Produces: application/json
CLI:
aws greengrass get-core-definition-version \ --core-definition-id <value> \ --core-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "CoreDefinitionId": "string", "CoreDefinitionVersionId": "string"}
Parameters:CoreDefinitionId (p. 431)
The ID of the core definition.
where used: path; required: true
type: string
100
AWS Greengrass API ReferenceGetCoreDefinitionVersion
CoreDefinitionVersionId (p. 432)
The ID of the core definition version.
where used: path; required: true
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
The ID of the core definition version.
type: stringVersion
The version of the core definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the core definition version was created.
type: stringDefinition
Information about a core definition version.
101
AWS Greengrass API ReferenceGetCoreDefinitionVersion
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: boolean400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
required: ["Message"]
102
AWS Greengrass API ReferenceGetDeploymentStatus
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: string
GetDeploymentStatusReturns the status of a deployment.
URI: GET /greengrass/groups/GroupId/deployments/DeploymentId/status
Produces: application/json
CLI:
aws greengrass get-deployment-status \ --group-id <value> \ --deployment-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "DeploymentId": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
103
AWS Greengrass API ReferenceGetDeploymentStatus
where used: path; required: true
type: string
DeploymentId (p. 449)
The ID of the deployment.
where used: path; required: true
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
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]
UpdatedAt
The time, in milliseconds since the epoch, when the deployment status was updated.
type: string
ErrorMessage
Error message
type: string
104
AWS Greengrass API ReferenceGetDeploymentStatus
ErrorDetails
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: 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.
105
AWS Greengrass API ReferenceGetDeviceDefinition
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
GetDeviceDefinitionRetrieves information about a device definition.
URI: GET /greengrass/definition/devices/DeviceDefinitionId
Produces: application/json
CLI:
aws greengrass get-device-definition \ --device-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "DeviceDefinitionId": "string"}
Parameters:DeviceDefinitionId (p. 449)
The ID of the device definition.
where used: path; required: true
type: string
Responses:200 (GetDeviceDefinitionResponse)
DefinitionInformation (p. 464)
{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string",
106
AWS Greengrass API ReferenceGetDeviceDefinition
"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
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
107
AWS Greengrass API ReferenceGetDeviceDefinitionVersion
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: string
GetDeviceDefinitionVersionRetrieves information about a device definition version.
URI: GET /greengrass/definition/devices/DeviceDefinitionId/versions/DeviceDefinitionVersionId
Produces: application/json
CLI:
aws greengrass get-device-definition-version \ --device-definition-id <value> \ --device-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "DeviceDefinitionId": "string", "DeviceDefinitionVersionId": "string"
108
AWS Greengrass API ReferenceGetDeviceDefinitionVersion
}
Parameters:DeviceDefinitionId (p. 449)
The ID of the device definition.
where used: path; required: true
type: stringDeviceDefinitionVersionId (p. 450)
The ID of the device definition version.
where used: path; required: true
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
The ID of the device definition version.
type: stringVersion
The version of the device definition version.
109
AWS Greengrass API ReferenceGetDeviceDefinitionVersion
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the device definition version was created.
type: stringDefinition
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
required: ["Id", "ThingArn", "CertificateArn"]Id
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:_-]+.
type: stringThingArn
The thing ARN of the device.
type: stringCertificateArn
The ARN of the certificate associated with the device.
type: stringSyncShadow
If true, the device's local shadow will be automatically synced with the cloud.
type: boolean400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" }
110
AWS Greengrass API ReferenceGetFunctionDefinition
]}
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: string
GetFunctionDefinitionRetrieves information about a Lambda function definition, including its creation time and latest version.
URI: GET /greengrass/definition/functions/FunctionDefinitionId
Produces: application/json
CLI:
aws greengrass get-function-definition \ --function-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "FunctionDefinitionId": "string"
111
AWS Greengrass API ReferenceGetFunctionDefinition
}
Parameters:FunctionDefinitionId (p. 450)
The ID of the Lambda function definition.
where used: path; required: true
type: string
Responses:200 (GetFunctionDefinitionResponse)
success
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.
112
AWS Greengrass API ReferenceGetFunctionDefinition
type: stringLatestVersion
The latest version of the definition.
type: stringLatestVersionArn
The ARN of the latest version of the definition.
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.
113
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
Produces: application/json
CLI:
aws greengrass get-function-definition-version \ --function-definition-id <value> \ --function-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "FunctionDefinitionId": "string", "FunctionDefinitionVersionId": "string"}
Parameters:FunctionDefinitionId (p. 450)
The ID of the Lambda function definition.
where used: path; required: true
type: stringFunctionDefinitionVersionId (p. 450)
The ID of the function definition version.
where used: path; required: true
type: string
Responses:200
success
GetFunctionDefinitionVersionResponse (p. 484)
{ "Arn": "string", "Id": "string",
114
AWS Greengrass API ReferenceGetFunctionDefinitionVersion
"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
Information about a function definition version.
type: objectArn
The ARN of the function definition version.
type: stringId
The ID of the function definition version.
type: stringVersion
The version of the function definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the function definition version was created.
type: stringDefinition
Information about a function definition version.
115
AWS Greengrass API ReferenceGetFunctionDefinitionVersion
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: booleanExecutable
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: integer
116
AWS Greengrass API ReferenceGetFunctionDefinitionVersion
EncodingType
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: boolean400
invalid request
GeneralError (p. 478)
{
117
AWS Greengrass API ReferenceGetGroup
"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: string
GetGroupRetrieves information about a group.
URI: GET /greengrass/groups/GroupId
Produces: application/json
CLI:
aws greengrass get-group \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
118
AWS Greengrass API ReferenceGetGroup
cli-input-json format:
{ "GroupId": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
Responses:200 (GetGroupResponse)
success
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.
119
AWS Greengrass API ReferenceGetGroup
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
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.
120
AWS Greengrass API ReferenceGetGroupCertificateAuthority
type: stringDetailedErrorMessage
A detailed error message.
type: string
GetGroupCertificateAuthorityRetreives the CA associated with a group. Returns the public key of the CA.
URI: GET /greengrass/groups/GroupId/certificateauthorities/CertificateAuthorityId
Produces: application/json
CLI:
aws greengrass get-group-certificate-authority \ --group-id <value> \ --certificate-authority-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "CertificateAuthorityId": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: stringCertificateAuthorityId (p. 431)
The ID of the certificate authority.
where used: path; required: true
type: string
Responses:200
Success. The response body contains the PKI Configuration.
GetGroupCertificateAuthorityResponse (p. 487)
121
AWS Greengrass API ReferenceGetGroupCertificateAuthority
{ "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
GroupCertificateAuthorityArn
The ARN of the certificate authority for the group.
type: string
GroupCertificateAuthorityId
The ID of the certificate authority for the group.
type: string
400
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: string
ErrorDetails
A list of error details.
122
AWS Greengrass API ReferenceGetGroupCertificateAuthority
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 (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: object
123
AWS Greengrass API ReferenceGetGroupCertificateConfiguration
DetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
GetGroupCertificateConfigurationRetrieves the current configuration for the CA used by the group.
URI: GET /greengrass/groups/GroupId/certificateauthorities/configuration/expiry
Produces: application/json
CLI:
aws greengrass get-group-certificate-configuration \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
Responses:200
Success. The response body contains the PKI Configuration.
GroupCertificateConfiguration (p. 496)
{ "GroupId": "string", "CertificateAuthorityExpiryInMilliseconds": "string", "CertificateExpiryInMilliseconds": "string"}
124
AWS Greengrass API ReferenceGetGroupCertificateConfiguration
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 (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.
125
AWS Greengrass API ReferenceGetGroupCertificateConfiguration
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string500
server error
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.
126
AWS Greengrass API ReferenceGetGroupVersion
type: string
GetGroupVersionRetrieves information about a group version.
URI: GET /greengrass/groups/GroupId/versions/GroupVersionId
Produces: application/json
CLI:
aws greengrass get-group-version \ --group-id <value> \ --group-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "GroupVersionId": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: stringGroupVersionId (p. 451)
The ID of the group version.
where used: path; required: true
type: string
Responses:200
success
GetGroupVersionResponse (p. 487)
{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": {
127
AWS Greengrass API ReferenceGetGroupVersion
"CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string" }}
GetGroupVersionResponse
Information about a group version.
type: objectArn
The ARN of the group version.
type: stringId
The ID of the group version.
type: stringVersion
The unique ID for the version of the group.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the group version was created.
type: stringDefinition
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: string
128
AWS Greengrass API ReferenceGetGroupVersion
LoggerDefinitionVersionArn
The ARN of the logger definition version for this group.
type: stringResourceDefinitionVersionArn
The resource definition version ARN for this 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: string
129
AWS Greengrass API ReferenceGetLoggerDefinition
GetLoggerDefinitionRetrieves information about a logger definition.
URI: GET /greengrass/definition/loggers/LoggerDefinitionId
Produces: application/json
CLI:
aws greengrass get-logger-definition \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "LoggerDefinitionId": "string"}
Parameters:LoggerDefinitionId (p. 451)
The ID of the logger definition.
where used: path; required: true
type: string
Responses:200 (GetLoggerDefinitionResponse)
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.
130
AWS Greengrass API ReferenceGetLoggerDefinition
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
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: string
131
AWS Greengrass API ReferenceGetLoggerDefinitionVersion
ErrorDetails
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: string
GetLoggerDefinitionVersionRetrieves information about a logger definition version.
URI: GET /greengrass/definition/loggers/LoggerDefinitionId/versions/LoggerDefinitionVersionId
Produces: application/json
CLI:
aws greengrass get-logger-definition-version \ --logger-definition-version-id <value> \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "LoggerDefinitionVersionId": "string", "LoggerDefinitionId": "string"}
Parameters:LoggerDefinitionVersionId (p. 451)
The ID of the logger definition version.
where used: path; required: true
type: string
132
AWS Greengrass API ReferenceGetLoggerDefinitionVersion
LoggerDefinitionId (p. 451)
The ID of the logger definition.
where used: path; required: true
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
Information about a logger definition version.
type: objectArn
The ARN of the logger definition version.
type: stringId
The ID of the logger definition version.
type: stringVersion
The version of the logger definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the logger definition version was created.
type: string
133
AWS Greengrass API ReferenceGetLoggerDefinitionVersion
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: integer400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]
134
AWS Greengrass API ReferenceGetResourceDefinition
}
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: string
GetResourceDefinitionRetrieves information about a resource definition, including its creation time and latest version.
URI: GET /greengrass/definition/resources/ResourceDefinitionId
Produces: application/json
CLI:
aws greengrass get-resource-definition \ --resource-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ResourceDefinitionId": "string"
135
AWS Greengrass API ReferenceGetResourceDefinition
}
Parameters:ResourceDefinitionId (p. 453)
The ID of the resource definition.
where used: path; required: true
type: string
Responses:200 (GetResourceDefinitionResponse)
success
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.
136
AWS Greengrass API ReferenceGetResourceDefinition
type: stringLatestVersion
The latest version of the definition.
type: stringLatestVersionArn
The ARN of the latest version of the definition.
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.
137
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
Produces: application/json
CLI:
aws greengrass get-resource-definition-version \ --resource-definition-id <value> \ --resource-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ResourceDefinitionId": "string", "ResourceDefinitionVersionId": "string"}
Parameters:ResourceDefinitionId (p. 453)
The ID of the resource definition.
where used: path; required: true
type: stringResourceDefinitionVersionId (p. 453)
The ID of the resource definition version.
where used: path; required: true
type: string
Responses:200
success
GetResourceDefinitionVersionResponse (p. 490)
{ "Arn": "string", "Id": "string",
138
AWS Greengrass API ReferenceGetResourceDefinitionVersion
"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
Information about a resource definition version.
type: objectArn
Arn of the resource definition version.
type: stringId
The ID of the resource definition version.
type: stringVersion
The version of the resource definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the resource definition version was created.
type: string
139
AWS Greengrass API ReferenceGetResourceDefinitionVersion
Definition
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
140
AWS Greengrass API ReferenceGetResourceDefinitionVersion
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.
type: objectSourcePath
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: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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: 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
141
AWS Greengrass API ReferenceGetResourceDefinitionVersion
DestinationPath
The absolute local path of the resource inside the Lambda environment.
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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
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.
142
AWS Greengrass API ReferenceGetServiceRoleForAccount
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
GetServiceRoleForAccountRetrieves the service role that is attached to your account.
URI: GET /greengrass/servicerole
CLI:
aws greengrass get-service-role-for-account \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
Responses:200
success
GetServiceRoleForAccountResponse (p. 494)
{ "AssociatedAt": "string", "RoleArn": "string"}
GetServiceRoleForAccountResponse
type: objectAssociatedAt
The time when the service role was associated with the account.
type: stringRoleArn
The ARN of the role which is associated with the account.
type: string500
server error
GeneralError (p. 478)
143
AWS Greengrass API ReferenceGetSubscriptionDefinition
{ "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: string
GetSubscriptionDefinitionRetrieves information about a subscription definition.
URI: GET /greengrass/definition/subscriptions/SubscriptionDefinitionId
Produces: application/json
CLI:
aws greengrass get-subscription-definition \ --subscription-definition-id <value> \ [--cli-input-json <value>] \
144
AWS Greengrass API ReferenceGetSubscriptionDefinition
[--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string"}
Parameters:SubscriptionDefinitionId (p. 453)
The ID of the subscription definition.
where used: path; required: true
type: string
Responses:200 (GetSubscriptionDefinitionResponse)
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.
145
AWS Greengrass API ReferenceGetSubscriptionDefinition
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
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.
146
AWS Greengrass API ReferenceGetSubscriptionDefinitionVersion
type: stringDetailedErrorMessage
A detailed error message.
type: string
GetSubscriptionDefinitionVersionRetrieves information about a subscription definition version.
URI: GET /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions/SubscriptionDefinitionVersionId
Produces: application/json
CLI:
aws greengrass get-subscription-definition-version \ --subscription-definition-id <value> \ --subscription-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string", "SubscriptionDefinitionVersionId": "string"}
Parameters:SubscriptionDefinitionId (p. 453)
The ID of the subscription definition.
where used: path; required: true
type: stringSubscriptionDefinitionVersionId (p. 454)
The ID of the subscription definition version.
where used: path; required: true
type: string
Responses:200 (GetSubscriptionDefinitionVersionResponse)
GetSubscriptionDefinitionVersionResponse (p. 494)
{
147
AWS Greengrass API ReferenceGetSubscriptionDefinitionVersion
"Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }}
GetSubscriptionDefinitionVersionResponse
Information about a subscription definition version.
type: objectArn
The ARN of the subscription definition version.
type: stringId
The ID of the subscription definition version.
type: stringVersion
The version of the subscription definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the subscription definition version was created.
type: stringDefinition
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"]
148
AWS Greengrass API ReferenceGetSubscriptionDefinitionVersion
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: 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)
149
AWS Greengrass API ReferenceListCoreDefinitionVersions
ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
ListCoreDefinitionVersionsLists the versions of a core definition.
URI: GET /greengrass/definition/cores/CoreDefinitionId/versions
Produces: application/json
CLI:
aws greengrass list-core-definition-versions \ --core-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "CoreDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}
Parameters:CoreDefinitionId (p. 431)
The ID of the core definition.
where used: path; required: true
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
150
AWS Greengrass API ReferenceListCoreDefinitionVersions
MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
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
Information about a version.
type: array
items: VersionInformation (p. 523)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
151
AWS Greengrass API ReferenceListCoreDefinitionVersions
CreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
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: string
152
AWS Greengrass API ReferenceListCoreDefinitions
ListCoreDefinitionsRetrieves a list of core definitions.
URI: GET /greengrass/definition/cores
Produces: application/json
CLI:
aws greengrass list-core-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "MaxResults": "integer", "NextToken": "string"}
Parameters:MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
Responses:200 (ListCoreDefinitionsResponse)
ListDefinitionsResponse (p. 499)
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" }
153
AWS Greengrass API ReferenceListCoreDefinitions
], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: objectDefinitions
Information about a definition.
type: array
items: DefinitionInformation (p. 464)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: stringNextToken
The token for the next set of results, or null if there are no additional results.
154
AWS Greengrass API ReferenceListDeployments
type: string
ListDeploymentsReturns a history of deployments for the group.
URI: GET /greengrass/groups/GroupId/deployments
Produces: application/json
CLI:
aws greengrass list-deployments \ --group-id <value> \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "MaxResults": "integer", "NextToken": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
Responses:200
Success. The response body contains the list of deployments for the given group.
155
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
Information about a deployment.
type: objectGroupArn
The ARN of the group for this deployment.
type: stringDeploymentId
The ID of the deployment.
type: stringDeploymentArn
The ARN of the deployment.
type: stringDeploymentType
type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]CreatedAt
The time, in milliseconds since the epoch, when the deployment was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
in: query
156
AWS Greengrass API ReferenceListDeviceDefinitionVersions
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: string
ListDeviceDefinitionVersionsLists the versions of a device definition.
URI: GET /greengrass/definition/devices/DeviceDefinitionId/versions
157
AWS Greengrass API ReferenceListDeviceDefinitionVersions
Produces: application/json
CLI:
aws greengrass list-device-definition-versions \ --device-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "DeviceDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}
Parameters:DeviceDefinitionId (p. 449)
The ID of the device definition.
where used: path; required: true
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: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
Responses:200 (ListDeviceDefinitionVersionsResponse)
ListVersionsResponse (p. 504)
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" }
158
AWS Greengrass API ReferenceListDeviceDefinitionVersions
], "NextToken": "string"}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" }
159
AWS Greengrass API ReferenceListDeviceDefinitions
]}
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: string
ListDeviceDefinitionsRetrieves a list of device definitions.
URI: GET /greengrass/definition/devices
Produces: application/json
CLI:
aws greengrass list-device-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
160
AWS Greengrass API ReferenceListDeviceDefinitions
"MaxResults": "integer", "NextToken": "string"}
Parameters:MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
Responses:200 (ListDeviceDefinitionsResponse)
ListDefinitionsResponse (p. 499)
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: objectDefinitions
Information about a definition.
type: array
items: DefinitionInformation (p. 464)DefinitionInformation
Information about a definition.
type: object
161
AWS Greengrass API ReferenceListFunctionDefinitionVersions
Name
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: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string
ListFunctionDefinitionVersionsLists the versions of a Lambda function definition.
URI: GET /greengrass/definition/functions/FunctionDefinitionId/versions
Produces: application/json
CLI:
aws greengrass list-function-definition-versions \ --function-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
162
AWS Greengrass API ReferenceListFunctionDefinitionVersions
cli-input-json format:
{ "FunctionDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}
Parameters:FunctionDefinitionId (p. 450)
The ID of the Lambda function definition.
where used: path; required: true
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: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
Responses:200 (ListFunctionDefinitionVersionsResponse)
ListVersionsResponse (p. 504)
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
163
AWS Greengrass API ReferenceListFunctionDefinitionVersions
type: array
items: VersionInformation (p. 523)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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
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.
164
AWS Greengrass API ReferenceListFunctionDefinitions
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: string
ListFunctionDefinitionsRetrieves a list of Lambda function definitions.
URI: GET /greengrass/definition/functions
Produces: application/json
CLI:
aws greengrass list-function-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "MaxResults": "integer", "NextToken": "string"}
Parameters:MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
165
AWS Greengrass API ReferenceListFunctionDefinitions
NextToken (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
Responses:200 (ListFunctionDefinitionsResponse)
Success. The response contains the IDs of all the Greengrass Lambda function definitions in thisaccount.
ListDefinitionsResponse (p. 499)
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: objectDefinitions
Information about a definition.
type: array
items: DefinitionInformation (p. 464)DefinitionInformation
Information about a definition.
type: objectName
The name of the definition.
type: stringId
The ID of the definition.
type: string
166
AWS Greengrass API ReferenceListGroupCertificateAuthorities
Arn
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: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string
ListGroupCertificateAuthoritiesRetrieves the current CAs for a group.
URI: GET /greengrass/groups/GroupId/certificateauthorities
Produces: application/json
CLI:
aws greengrass list-group-certificate-authorities \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
167
AWS Greengrass API ReferenceListGroupCertificateAuthorities
where used: path; required: true
type: string
Responses:200
Success. The response body contains the PKI Configuration.
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
Information about a certificate authority for a group.
type: objectGroupCertificateAuthorityId
The ID of the certificate authority for the group.
type: stringGroupCertificateAuthorityArn
The ARN of the certificate authority for the group.
type: string400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string",
168
AWS Greengrass API ReferenceListGroupCertificateAuthorities
"DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
required: ["Message"]
Message
A message containing information about the error.
type: string
ErrorDetails
A list of error details.
type: array
items: ErrorDetail (p. 469)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
500
server error
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
169
AWS Greengrass API ReferenceListGroupVersions
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: string
ListGroupVersionsLists the versions of a group.
URI: GET /greengrass/groups/GroupId/versions
Produces: application/json
CLI:
aws greengrass list-group-versions \ --group-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "NextToken": "string", "MaxResults": "integer"}
170
AWS Greengrass API ReferenceListGroupVersions
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
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: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
Responses:200 (ListGroupVersionsResponse)
Success. The response contains the list of versions and metadata for the given group.
ListVersionsResponse (p. 504)
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)VersionInformation
Information about a version.
171
AWS Greengrass API ReferenceListGroupVersions
type: objectArn
The ARN of the version.
type: stringId
The ID of the version.
type: stringVersion
The unique ID of the version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
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
172
AWS Greengrass API ReferenceListGroups
items: ErrorDetail (p. 469)ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
ListGroupsRetrieves a list of groups.
URI: GET /greengrass/groups
Produces: application/json
CLI:
aws greengrass list-groups \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "MaxResults": "integer", "NextToken": "string"}
Parameters:MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
173
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
Information about a group.
type: objectName
The name of the group.
type: stringId
The ID of the group.
type: stringArn
The ARN of the group.
type: stringLastUpdatedTimestamp
The time, in milliseconds since the epoch, when the group was last updated.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the group was created.
174
AWS Greengrass API ReferenceListLoggerDefinitionVersions
type: stringLatestVersion
The latest version of the group.
type: stringLatestVersionArn
The ARN of the latest version of the group.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string
ListLoggerDefinitionVersionsLists the versions of a logger definition.
URI: GET /greengrass/definition/loggers/LoggerDefinitionId/versions
Produces: application/json
CLI:
aws greengrass list-logger-definition-versions \ --logger-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "LoggerDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}
Parameters:LoggerDefinitionId (p. 451)
The ID of the logger definition.
where used: path; required: true
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
175
AWS Greengrass API ReferenceListLoggerDefinitionVersions
type: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
Responses:200 (ListLoggerDefinitionVersionsResponse)
ListVersionsResponse (p. 504)
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)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
176
AWS Greengrass API ReferenceListLoggerDefinitionVersions
CreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
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: string
177
AWS Greengrass API ReferenceListLoggerDefinitions
ListLoggerDefinitionsRetrieves a list of logger definitions.
URI: GET /greengrass/definition/loggers
Produces: application/json
CLI:
aws greengrass list-logger-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "MaxResults": "integer", "NextToken": "string"}
Parameters:MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
Responses:200 (ListLoggerDefinitionsResponse)
ListDefinitionsResponse (p. 499)
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" }
178
AWS Greengrass API ReferenceListLoggerDefinitions
], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: objectDefinitions
Information about a definition.
type: array
items: DefinitionInformation (p. 464)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: stringNextToken
The token for the next set of results, or null if there are no additional results.
179
AWS Greengrass API ReferenceListResourceDefinitionVersions
type: string
ListResourceDefinitionVersionsLists the versions of a resource definition.
URI: GET /greengrass/definition/resources/ResourceDefinitionId/versions
Produces: application/json
CLI:
aws greengrass list-resource-definition-versions \ --resource-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ResourceDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}
Parameters:ResourceDefinitionId (p. 453)
The ID of the resource definition.
where used: path; required: true
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: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
Responses:200 (ListResourceDefinitionVersionsResponse)
ListVersionsResponse (p. 504)
180
AWS Greengrass API ReferenceListResourceDefinitionVersions
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string400
invalid request
GeneralError (p. 478)
181
AWS Greengrass API ReferenceListResourceDefinitions
{ "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: string
ListResourceDefinitionsRetrieves a list of resource definitions.
URI: GET /greengrass/definition/resources
Produces: application/json
CLI:
aws greengrass list-resource-definitions \ [--max-results <value>] \ [--next-token <value>] \
182
AWS Greengrass API ReferenceListResourceDefinitions
[--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "MaxResults": "integer", "NextToken": "string"}
Parameters:MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
Responses:200 (ListResourceDefinitionsResponse)
The IDs of all the Greengrass resource definitions in this account.
ListDefinitionsResponse (p. 499)
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: objectDefinitions
Information about a definition.
183
AWS Greengrass API ReferenceListSubscriptionDefinitionVersions
type: array
items: DefinitionInformation (p. 464)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: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string
ListSubscriptionDefinitionVersionsLists the versions of a subscription definition.
URI: GET /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions
Produces: application/json
184
AWS Greengrass API ReferenceListSubscriptionDefinitionVersions
CLI:
aws greengrass list-subscription-definition-versions \ --subscription-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}
Parameters:SubscriptionDefinitionId (p. 453)
The ID of the subscription definition.
where used: path; required: true
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: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
Responses:200 (ListSubscriptionDefinitionVersionsResponse)
ListVersionsResponse (p. 504)
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"
185
AWS Greengrass API ReferenceListSubscriptionDefinitionVersions
}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]
186
AWS Greengrass API ReferenceListSubscriptionDefinitions
}
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: string
ListSubscriptionDefinitionsRetrieves a list of subscription definitions.
URI: GET /greengrass/definition/subscriptions
Produces: application/json
CLI:
aws greengrass list-subscription-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "MaxResults": "integer",
187
AWS Greengrass API ReferenceListSubscriptionDefinitions
"NextToken": "string"}
Parameters:MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
Responses:200 (ListSubscriptionDefinitionsResponse)
ListDefinitionsResponse (p. 499)
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: objectDefinitions
Information about a definition.
type: array
items: DefinitionInformation (p. 464)DefinitionInformation
Information about a definition.
type: object
188
AWS Greengrass API ReferenceResetDeployments
Name
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: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string
ResetDeploymentsResets a group's deployments.
URI: POST /greengrass/groups/GroupId/deployments/$reset
Produces: application/json
CLI:
aws greengrass reset-deployments \ --group-id <value> \ [--force | --no-force] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
189
AWS Greengrass API ReferenceResetDeployments
cli-input-json format:
{ "GroupId": "string", "Force": "boolean", "AmznClientToken": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: stringResetDeploymentsRequestBody (p. 452)
Information needed to reset deployments.
where used: body; required: true
{ "Force": true}
schema:ResetDeploymentsRequest
Information about a group reset request.
type: objectForce
If true, performs a best-effort only core reset.
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
Success. The group's deployments were reset.
ResetDeploymentsResponse (p. 510)
{ "DeploymentArn": "string",
190
AWS Greengrass API ReferenceResetDeployments
"DeploymentId": "string"}
ResetDeploymentsResponse
type: objectDeploymentArn
The ARN of the deployment.
type: stringDeploymentId
The ID of the deployment.
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.
191
AWS Greengrass API ReferenceUpdateConnectivityInfo
type: stringDetailedErrorMessage
A detailed error message.
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
Produces: application/json
CLI:
aws greengrass update-connectivity-info \ --thing-name <value> \ [--connectivity-info <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ThingName": "string", "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": "int32-integer", "Metadata": "string" } ]}
Parameters:ThingName (p. 454)
The thing name.
where used: path; required: true
type: stringUpdateConnectivityInfoRequestBody (p. 454)
The connectivity information.
where used: body; required:
{ "ConnectivityInfo": [ {
192
AWS Greengrass API ReferenceUpdateConnectivityInfo
"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
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: string
Responses:200
success
UpdateConnectivityInfoResponse (p. 522)
{ "message": "string", "Version": "string"}
193
AWS Greengrass API ReferenceUpdateConnectivityInfo
message
A message about the connectivity info update request.
type: stringVersion
The new version of the connectivity info.
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: string
194
AWS Greengrass API ReferenceUpdateCoreDefinition
500
server error
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: string
UpdateCoreDefinitionUpdates a core definition.
URI: PUT /greengrass/definition/cores/CoreDefinitionId
Produces: application/json
195
AWS Greengrass API ReferenceUpdateCoreDefinition
CLI:
aws greengrass update-core-definition \ --core-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "CoreDefinitionId": "string", "Name": "string"}
Parameters:CoreDefinitionId (p. 431)
The ID of the core definition.
where used: path; required: true
type: stringUpdateDefinitionRequestBody (p. 455)
where used: body; required: true
{ "Name": "string"}
schema:Name
The name of the definition.
required: true
type: string
Responses:200
success
Empty (p. 469)
{}
Empty Schema
Empty
196
AWS Greengrass API ReferenceUpdateDeviceDefinition
type: object400
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: string
UpdateDeviceDefinitionUpdates a device definition.
URI: PUT /greengrass/definition/devices/DeviceDefinitionId
Produces: application/json
197
AWS Greengrass API ReferenceUpdateDeviceDefinition
CLI:
aws greengrass update-device-definition \ --device-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "DeviceDefinitionId": "string", "Name": "string"}
Parameters:DeviceDefinitionId (p. 449)
The ID of the device definition.
where used: path; required: true
type: stringUpdateDefinitionRequestBody (p. 455)
where used: body; required: true
{ "Name": "string"}
schema:Name
The name of the definition.
required: true
type: string
Responses:200
success
Empty (p. 469)
{}
Empty Schema
Empty
198
AWS Greengrass API ReferenceUpdateFunctionDefinition
type: object400
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: string
UpdateFunctionDefinitionUpdates a Lambda function definition.
URI: PUT /greengrass/definition/functions/FunctionDefinitionId
Produces: application/json
199
AWS Greengrass API ReferenceUpdateFunctionDefinition
CLI:
aws greengrass update-function-definition \ --function-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "FunctionDefinitionId": "string", "Name": "string"}
Parameters:FunctionDefinitionId (p. 450)
The ID of the Lambda function definition.
where used: path; required: true
type: stringUpdateDefinitionRequestBody (p. 455)
where used: body; required: true
{ "Name": "string"}
schema:Name
The name of the definition.
required: true
type: string
Responses:200
success
Empty (p. 469)
{}
Empty Schema
Empty
200
AWS Greengrass API ReferenceUpdateGroup
type: object400
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: string
UpdateGroupUpdates a group.
URI: PUT /greengrass/groups/GroupId
Produces: application/json
201
AWS Greengrass API ReferenceUpdateGroup
CLI:
aws greengrass update-group \ --group-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "Name": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: stringUpdateDefinitionRequestBody (p. 455)
where used: body; required: true
{ "Name": "string"}
schema:Name
The name of the definition.
required: true
type: string
Responses:200
success
Empty (p. 469)
{}
Empty Schema
Empty
202
AWS Greengrass API ReferenceUpdateGroupCertificateConfiguration
type: object400
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: string
UpdateGroupCertificateConfigurationUpdates the Certificate expiry time for a group.
URI: PUT /greengrass/groups/GroupId/certificateauthorities/configuration/expiry
203
AWS Greengrass API ReferenceUpdateGroupCertificateConfiguration
Produces: application/json
CLI:
aws greengrass update-group-certificate-configuration \ --group-id <value> \ [--certificate-expiry-in-milliseconds <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "CertificateExpiryInMilliseconds": "string"}
Parameters:GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: stringUpdateGroupCertificateConfigurationRequestBody (p. 456)
where used: body; required: true
{ "CertificateExpiryInMilliseconds": "string"}
schema:updateGroupCertificateConfigurationRequest
type: object
required: ["CertificateExpiryInMilliseconds"]CertificateExpiryInMilliseconds
The amount of time remaining before the certificate expires, in milliseconds.
type: string
Responses:200
Success. The response body contains the PKI Configuration.
GroupCertificateConfiguration (p. 496)
{
204
AWS Greengrass API ReferenceUpdateGroupCertificateConfiguration
"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 (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)
205
AWS Greengrass API ReferenceUpdateGroupCertificateConfiguration
ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string500
server error
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.
206
AWS Greengrass API ReferenceUpdateLoggerDefinition
type: stringDetailedErrorMessage
A detailed error message.
type: string
UpdateLoggerDefinitionUpdates a logger definition.
URI: PUT /greengrass/definition/loggers/LoggerDefinitionId
Produces: application/json
CLI:
aws greengrass update-logger-definition \ --logger-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "LoggerDefinitionId": "string", "Name": "string"}
Parameters:LoggerDefinitionId (p. 451)
The ID of the logger definition.
where used: path; required: true
type: stringUpdateDefinitionRequestBody (p. 455)
where used: body; required: true
{ "Name": "string"}
schema:Name
The name of the definition.
required: true
type: string
207
AWS Greengrass API ReferenceUpdateLoggerDefinition
Responses:200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
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.
208
AWS Greengrass API ReferenceUpdateResourceDefinition
type: stringDetailedErrorMessage
A detailed error message.
type: string
UpdateResourceDefinitionUpdates a resource definition.
URI: PUT /greengrass/definition/resources/ResourceDefinitionId
Produces: application/json
CLI:
aws greengrass update-resource-definition \ --resource-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ResourceDefinitionId": "string", "Name": "string"}
Parameters:ResourceDefinitionId (p. 453)
The ID of the resource definition.
where used: path; required: true
type: stringUpdateDefinitionRequestBody (p. 455)
where used: body; required: true
{ "Name": "string"}
schema:Name
The name of the definition.
required: true
type: string
209
AWS Greengrass API ReferenceUpdateResourceDefinition
Responses:200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
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.
210
AWS Greengrass API ReferenceUpdateSubscriptionDefinition
type: stringDetailedErrorMessage
A detailed error message.
type: string
UpdateSubscriptionDefinitionUpdates a subscription definition.
URI: PUT /greengrass/definition/subscriptions/SubscriptionDefinitionId
Produces: application/json
CLI:
aws greengrass update-subscription-definition \ --subscription-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string", "Name": "string"}
Parameters:SubscriptionDefinitionId (p. 453)
The ID of the subscription definition.
where used: path; required: true
type: stringUpdateDefinitionRequestBody (p. 455)
where used: body; required: true
{ "Name": "string"}
schema:Name
The name of the definition.
required: true
type: string
211
AWS Greengrass API ReferenceUpdateSubscriptionDefinition
Responses:200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
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.
212
AWS Greengrass API ReferenceEndpoints
type: stringDetailedErrorMessage
A detailed error message.
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)
213
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.
Produces: application/json
Query Parameters
MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
CLI
aws greengrass list-core-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "MaxResults": "integer", "NextToken": "string"}
Responses
200 (ListCoreDefinitionsResponse)
ListDefinitionsResponse (p. 499)
214
AWS Greengrass API Reference/greengrass/definition/cores
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: objectDefinitions
Information about a definition.
type: array
items: DefinitionInformation (p. 464)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.
215
AWS Greengrass API Reference/greengrass/definition/cores
type: stringLatestVersionArn
The ARN of the latest version of the definition.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
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.
Produces: application/json
Body Parameters
CreateCoreDefinitionRequestBody (p. 432)
Information needed to create a core definition.
where used: body; required: true
{ "Name": "string", "InitialVersion": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}
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.
216
AWS Greengrass API Reference/greengrass/definition/cores
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: string
ThingArn
The ARN of the thing which is the core.
type: string
CertificateArn
The ARN of the certificate associated with the core.
type: string
SyncShadow
If true, the core's local shadow is automatically synced with the cloud.
type: boolean
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
CLI
aws greengrass create-core-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "Name": "string",
217
AWS Greengrass API Reference/greengrass/definition/cores
"InitialVersion": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ] }, "AmznClientToken": "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: string
218
AWS Greengrass API Reference/greengrass/definition/cores
LatestVersion
The latest version of the definition.
type: stringLatestVersionArn
The ARN of the latest version of the definition.
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.
219
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.
Produces: application/json
Path Parameters
CoreDefinitionId (p. 431)
The ID of the core definition.
where used: path; required: true
type: string
CLI
aws greengrass get-core-definition \ --core-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "CoreDefinitionId": "string"}
Responses
200 (GetCoreDefinitionResponse)
DefinitionInformation (p. 464)
{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string"}
DefinitionInformation
Information about a definition.
220
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId
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
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
required: ["Message"]
221
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId
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: string
DELETEDELETE /greengrass/definition/cores/CoreDefinitionId
Operation ID: DeleteCoreDefinition (p. 76)
Deletes a core definition.
Produces: application/json
Path Parameters
CoreDefinitionId (p. 431)
The ID of the core definition.
where used: path; required: true
type: string
CLI
aws greengrass delete-core-definition \ --core-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
222
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId
{ "CoreDefinitionId": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
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.
223
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
PUTPUT /greengrass/definition/cores/CoreDefinitionId
Operation ID: UpdateCoreDefinition (p. 195)
Updates a core definition.
Produces: application/json
Body Parameters
UpdateDefinitionRequestBody (p. 455)
where used: body; required: true
{ "Name": "string"}
Name
The name of the definition.
required: true
type: string
Path Parameters
CoreDefinitionId (p. 431)
The ID of the core definition.
where used: path; required: true
type: string
CLI
aws greengrass update-core-definition \ --core-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \
224
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId
[--generate-cli-skeleton]
cli-input-json format:
{ "CoreDefinitionId": "string", "Name": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
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
225
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId/versions
items: ErrorDetail (p. 469)ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
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.
Produces: application/json
Body Parameters
CreateCoreDefinitionVersionRequestBody (p. 432)
where used: body; required: true
{ "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}
CoreDefinitionVersion
Information about a core definition version.
type: objectCores
A list of cores in the core definition version.
226
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId/versions
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: string
ThingArn
The ARN of the thing which is the core.
type: string
CertificateArn
The ARN of the certificate associated with the core.
type: string
SyncShadow
If true, the core's local shadow is automatically synced with the cloud.
type: boolean
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
CoreDefinitionId (p. 431)
The ID of the core definition.
where used: path; required: true
type: string
CLI
aws greengrass create-core-definition-version \
227
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId/versions
--core-definition-id <value> \ [--cores <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "CoreDefinitionId": "string", "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ], "AmznClientToken": "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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: string
228
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId/versions
400
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: string
GETGET /greengrass/definition/cores/CoreDefinitionId/versions
Operation ID: ListCoreDefinitionVersions (p. 150)
Lists the versions of a core definition.
Produces: application/json
229
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId/versions
Path Parameters
CoreDefinitionId (p. 431)
The ID of the core definition.
where used: path; required: true
type: string
Query Parameters
NextToken (p. 452)
The token for the next set of results, or null if there are no additional results.
where used: query; required: false
type: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
CLI
aws greengrass list-core-definition-versions \ --core-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "CoreDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}
Responses
200 (ListCoreDefinitionVersionsResponse)
ListVersionsResponse (p. 504)
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string"
230
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId/versions
} ], "NextToken": "string"}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" }
231
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId/
versions/CoreDefinitionVersionId
]}
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: 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.
Produces: application/json
Path Parameters
CoreDefinitionId (p. 431)
The ID of the core definition.
232
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId/
versions/CoreDefinitionVersionId
where used: path; required: true
type: stringCoreDefinitionVersionId (p. 432)
The ID of the core definition version.
where used: path; required: true
type: string
CLI
aws greengrass get-core-definition-version \ --core-definition-id <value> \ --core-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "CoreDefinitionId": "string", "CoreDefinitionVersionId": "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: string
233
AWS Greengrass API Reference/greengrass/definition/cores/CoreDefinitionId/
versions/CoreDefinitionVersionId
Id
The ID of the core definition version.
type: stringVersion
The version of the core definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the core definition version was created.
type: stringDefinition
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: boolean400
invalid request
234
AWS Greengrass API Reference/greengrass/definition/devices
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: string
/greengrass/definition/devicesGETGET /greengrass/definition/devices
Operation ID: ListDeviceDefinitions (p. 160)
Retrieves a list of device definitions.
Produces: application/json
235
AWS Greengrass API Reference/greengrass/definition/devices
Query Parameters
MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
CLI
aws greengrass list-device-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "MaxResults": "integer", "NextToken": "string"}
Responses
200 (ListDeviceDefinitionsResponse)
ListDefinitionsResponse (p. 499)
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: object
236
AWS Greengrass API Reference/greengrass/definition/devices
Definitions
Information about a definition.
type: array
items: DefinitionInformation (p. 464)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: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string
POSTPOST /greengrass/definition/devices
Operation ID: CreateDeviceDefinition (p. 18)
237
AWS Greengrass API Reference/greengrass/definition/devices
Creates a device definition. You may provide the initial version of the device definition now or useCreateDeviceDefinitionVersion at a later time.
Produces: application/json
Body Parameters
CreateDeviceDefinitionRequestBody (p. 434)
Information needed to create a device definition.
where used: body; required: true
{ "Name": "string", "InitialVersion": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}
Name
The name of the device definition.
type: stringInitialVersion
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
required: ["Id", "ThingArn", "CertificateArn"]Id
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:_-]+.
type: stringThingArn
The thing ARN of the device.
238
AWS Greengrass API Reference/greengrass/definition/devices
type: stringCertificateArn
The ARN of the certificate associated with the device.
type: stringSyncShadow
If true, the device's local shadow will be automatically synced with the cloud.
type: boolean
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
CLI
aws greengrass create-device-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "Name": "string", "InitialVersion": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ] }, "AmznClientToken": "string"}
Responses
200 (CreateDeviceDefinitionResponse)
DefinitionInformation (p. 464)
{ "Name": "string", "Id": "string",
239
AWS Greengrass API Reference/greengrass/definition/devices
"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
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string",
240
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId
"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: string
/greengrass/definition/devices/DeviceDefinitionId
GETGET /greengrass/definition/devices/DeviceDefinitionId
Operation ID: GetDeviceDefinition (p. 106)
Retrieves information about a device definition.
Produces: application/json
Path Parameters
DeviceDefinitionId (p. 449)
The ID of the device definition.
241
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId
where used: path; required: true
type: string
CLI
aws greengrass get-device-definition \ --device-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "DeviceDefinitionId": "string"}
Responses
200 (GetDeviceDefinitionResponse)
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: string
242
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId
CreationTimestamp
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
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.
243
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId
type: stringDetailedErrorMessage
A detailed error message.
type: string
DELETEDELETE /greengrass/definition/devices/DeviceDefinitionId
Operation ID: DeleteDeviceDefinition (p. 77)
Deletes a device definition.
Produces: application/json
Path Parameters
DeviceDefinitionId (p. 449)
The ID of the device definition.
where used: path; required: true
type: string
CLI
aws greengrass delete-device-definition \ --device-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "DeviceDefinitionId": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object
244
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId
400
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: string
PUTPUT /greengrass/definition/devices/DeviceDefinitionId
Operation ID: UpdateDeviceDefinition (p. 197)
Updates a device definition.
Produces: application/json
245
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId
Body Parameters
UpdateDefinitionRequestBody (p. 455)
where used: body; required: true
{ "Name": "string"}
Name
The name of the definition.
required: true
type: string
Path Parameters
DeviceDefinitionId (p. 449)
The ID of the device definition.
where used: path; required: true
type: string
CLI
aws greengrass update-device-definition \ --device-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "DeviceDefinitionId": "string", "Name": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
246
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId/versions
type: object400
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: string
/greengrass/definition/devices/DeviceDefinitionId/versionsPOSTPOST /greengrass/definition/devices/DeviceDefinitionId/versions
247
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId/versions
Operation ID: CreateDeviceDefinitionVersion (p. 22)
Creates a version of a device definition that has already been defined.
Produces: application/json
Body Parameters
CreateDeviceDefinitionVersionRequestBody (p. 435)
where used: body; required: true
{ "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}
DeviceDefinitionVersion
Information about a device definition version.
type: object
Devices
A list of devices in the definition version.
type: array
items: Device (p. 467)
Device
Information about a device.
type: object
required: ["Id", "ThingArn", "CertificateArn"]
Id
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:_-]+.
type: string
ThingArn
The thing ARN of the device.
type: string
CertificateArn
The ARN of the certificate associated with the device.
type: string
248
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId/versions
SyncShadow
If true, the device's local shadow will be automatically synced with the cloud.
type: boolean
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
DeviceDefinitionId (p. 449)
The ID of the device definition.
where used: path; required: true
type: string
CLI
aws greengrass create-device-definition-version \ --device-definition-id <value> \ [--devices <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "DeviceDefinitionId": "string", "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ], "AmznClientToken": "string"}
Responses
200 (CreateDeviceDefinitionVersionResponse)
VersionInformation (p. 523)
{
249
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId/versions
"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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
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: string
250
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId/versions
ErrorDetails
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: string
GETGET /greengrass/definition/devices/DeviceDefinitionId/versions
Operation ID: ListDeviceDefinitionVersions (p. 157)
Lists the versions of a device definition.
Produces: application/json
Path Parameters
DeviceDefinitionId (p. 449)
The ID of the device definition.
where used: path; required: true
type: string
Query Parameters
NextToken (p. 452)
The token for the next set of results, or null if there are no additional results.
where used: query; required: false
type: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
251
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId/versions
type: integer
CLI
aws greengrass list-device-definition-versions \ --device-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "DeviceDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}
Responses
200 (ListDeviceDefinitionVersionsResponse)
ListVersionsResponse (p. 504)
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)VersionInformation
Information about a version.
type: objectArn
The ARN of the version.
252
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId/versions
type: stringId
The ID of the version.
type: stringVersion
The unique ID of the version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
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.
253
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId/
versions/DeviceDefinitionVersionId
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
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.
Produces: application/json
Path Parameters
DeviceDefinitionId (p. 449)
The ID of the device definition.
where used: path; required: true
type: stringDeviceDefinitionVersionId (p. 450)
The ID of the device definition version.
where used: path; required: true
type: string
CLI
aws greengrass get-device-definition-version \ --device-definition-id <value> \ --device-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
254
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId/
versions/DeviceDefinitionVersionId
"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 } ] }}
GetDeviceDefinitionVersionResponse
type: object
Arn
The ARN of the device definition version.
type: string
Id
The ID of the device definition version.
type: string
Version
The version of the device definition version.
type: string
CreationTimestamp
The time, in milliseconds since the epoch, when the device definition version was created.
type: string
Definition
Information about a device definition version.
type: object
Devices
A list of devices in the definition version.
255
AWS Greengrass API Reference/greengrass/definition/devices/DeviceDefinitionId/
versions/DeviceDefinitionVersionId
type: array
items: Device (p. 467)Device
Information about a device.
type: object
required: ["Id", "ThingArn", "CertificateArn"]Id
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:_-]+.
type: stringThingArn
The thing ARN of the device.
type: stringCertificateArn
The ARN of the certificate associated with the device.
type: stringSyncShadow
If true, the device's local shadow will be automatically synced with the cloud.
type: boolean400
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: string
256
AWS Greengrass API Reference/greengrass/definition/functions
ErrorDetails
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: string
/greengrass/definition/functionsGETGET /greengrass/definition/functions
Operation ID: ListFunctionDefinitions (p. 165)
Retrieves a list of Lambda function definitions.
Produces: application/json
Query Parameters
MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
CLI
aws greengrass list-function-definitions \ [--max-results <value>] \ [--next-token <value>] \
257
AWS Greengrass API Reference/greengrass/definition/functions
[--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "MaxResults": "integer", "NextToken": "string"}
Responses
200 (ListFunctionDefinitionsResponse)
Success. The response contains the IDs of all the Greengrass Lambda function definitions in thisaccount.
ListDefinitionsResponse (p. 499)
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: objectDefinitions
Information about a definition.
type: array
items: DefinitionInformation (p. 464)DefinitionInformation
Information about a definition.
type: objectName
The name of the definition.
type: stringId
The ID of the definition.
258
AWS Greengrass API Reference/greengrass/definition/functions
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: stringNextToken
The token for the next set of results, or null if there are no additional results.
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.
Produces: application/json
Body Parameters
CreateFunctionDefinitionRequestBody (p. 436)
where used: body; required: true
{ "Name": "string", "InitialVersion": { "Functions": [ { "Id": "string", "FunctionArn": "string",
259
AWS Greengrass API Reference/greengrass/definition/functions
"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 } } } ] }}
Name
The name of the function definition.
type: stringInitialVersion
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: string
260
AWS Greengrass API Reference/greengrass/definition/functions
FunctionConfiguration
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: booleanExecutable
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)
261
AWS Greengrass API Reference/greengrass/definition/functions
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: boolean
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
CLI
aws greengrass create-function-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "Name": "string", "InitialVersion": { "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": "boolean", "Executable": "string",
262
AWS Greengrass API Reference/greengrass/definition/functions
"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)
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: string
263
AWS Greengrass API Reference/greengrass/definition/functions
LastUpdatedTimestamp
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
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: object
264
AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId
DetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
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.
Produces: application/json
Path Parameters
FunctionDefinitionId (p. 450)
The ID of the Lambda function definition.
where used: path; required: true
type: string
CLI
aws greengrass get-function-definition \ --function-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "FunctionDefinitionId": "string"}
Responses
200 (GetFunctionDefinitionResponse)
success
DefinitionInformation (p. 464)
265
AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId
{ "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
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [
266
AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId
{ "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: string
DELETEDELETE /greengrass/definition/functions/FunctionDefinitionId
Operation ID: DeleteFunctionDefinition (p. 79)
Deletes a Lambda function definition.
Produces: application/json
Path Parameters
FunctionDefinitionId (p. 450)
The ID of the Lambda function definition.
where used: path; required: true
267
AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId
type: string
CLI
aws greengrass delete-function-definition \ --function-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "FunctionDefinitionId": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
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.
268
AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId
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: string
PUTPUT /greengrass/definition/functions/FunctionDefinitionId
Operation ID: UpdateFunctionDefinition (p. 199)
Updates a Lambda function definition.
Produces: application/json
Body Parameters
UpdateDefinitionRequestBody (p. 455)
where used: body; required: true
{ "Name": "string"}
Name
The name of the definition.
required: true
type: string
Path Parameters
FunctionDefinitionId (p. 450)
The ID of the Lambda function definition.
269
AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId
where used: path; required: true
type: string
CLI
aws greengrass update-function-definition \ --function-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "FunctionDefinitionId": "string", "Name": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
required: ["Message"]
270
AWS Greengrass API Reference/greengrass/definition/functions/
FunctionDefinitionId/versions
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: 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.
Produces: application/json
Body Parameters
CreateFunctionDefinitionVersionRequestBody (p. 437)
Information about the function definition version.
where used: body; required: true
{ "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string",
271
AWS Greengrass API Reference/greengrass/definition/functions/
FunctionDefinitionId/versions
"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
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.
272
AWS Greengrass API Reference/greengrass/definition/functions/
FunctionDefinitionId/versions
type: booleanExecutable
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.)
273
AWS Greengrass API Reference/greengrass/definition/functions/
FunctionDefinitionId/versions
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: boolean
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
FunctionDefinitionId (p. 450)
The ID of the Lambda function definition.
where used: path; required: true
type: string
CLI
aws greengrass create-function-definition-version \ --function-definition-id <value> \ [--functions <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "FunctionDefinitionId": "string", "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": "boolean", "Executable": "string", "ExecArgs": "string", "MemorySize": "integer",
274
AWS Greengrass API Reference/greengrass/definition/functions/
FunctionDefinitionId/versions
"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 (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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: string
275
AWS Greengrass API Reference/greengrass/definition/functions/
FunctionDefinitionId/versions
400
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: string
GETGET /greengrass/definition/functions/FunctionDefinitionId/versions
Operation ID: ListFunctionDefinitionVersions (p. 162)
Lists the versions of a Lambda function definition.
276
AWS Greengrass API Reference/greengrass/definition/functions/
FunctionDefinitionId/versions
Produces: application/json
Path Parameters
FunctionDefinitionId (p. 450)
The ID of the Lambda function definition.
where used: path; required: true
type: string
Query Parameters
NextToken (p. 452)
The token for the next set of results, or null if there are no additional results.
where used: query; required: false
type: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
CLI
aws greengrass list-function-definition-versions \ --function-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "FunctionDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}
Responses
200 (ListFunctionDefinitionVersionsResponse)
ListVersionsResponse (p. 504)
{ "Versions": [ { "Arn": "string", "Id": "string",
277
AWS Greengrass API Reference/greengrass/definition/functions/
FunctionDefinitionId/versions
"Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ {
278
AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId/
versions/FunctionDefinitionVersionId
"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: 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.
Produces: application/json
279
AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId/
versions/FunctionDefinitionVersionId
Path Parameters
FunctionDefinitionId (p. 450)
The ID of the Lambda function definition.
where used: path; required: true
type: stringFunctionDefinitionVersionId (p. 450)
The ID of the function definition version.
where used: path; required: true
type: string
CLI
aws greengrass get-function-definition-version \ --function-definition-id <value> \ --function-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "FunctionDefinitionId": "string", "FunctionDefinitionVersionId": "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": {
280
AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId/
versions/FunctionDefinitionVersionId
"additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ] }}
GetFunctionDefinitionVersionResponse
Information about a function definition version.
type: objectArn
The ARN of the function definition version.
type: stringId
The ID of the function definition version.
type: stringVersion
The version of the function definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the function definition version was created.
type: stringDefinition
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"]
281
AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId/
versions/FunctionDefinitionVersionId
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: booleanExecutable
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.
282
AWS Greengrass API Reference/greengrass/definition/functions/FunctionDefinitionId/
versions/FunctionDefinitionVersionId
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: boolean400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
283
AWS Greengrass API Reference/greengrass/definition/loggers
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: string
/greengrass/definition/loggers
GETGET /greengrass/definition/loggers
Operation ID: ListLoggerDefinitions (p. 178)
Retrieves a list of logger definitions.
Produces: application/json
Query Parameters
MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
284
AWS Greengrass API Reference/greengrass/definition/loggers
CLI
aws greengrass list-logger-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "MaxResults": "integer", "NextToken": "string"}
Responses
200 (ListLoggerDefinitionsResponse)
ListDefinitionsResponse (p. 499)
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: objectDefinitions
Information about a definition.
type: array
items: DefinitionInformation (p. 464)DefinitionInformation
Information about a definition.
type: objectName
The name of the definition.
type: string
285
AWS Greengrass API Reference/greengrass/definition/loggers
Id
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: stringNextToken
The token for the next set of results, or null if there are no additional results.
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.
Produces: application/json
Body Parameters
CreateLoggerDefinitionRequestBody (p. 441)
where used: body; required: true
{ "Name": "string", "InitialVersion": { "Loggers": [
286
AWS Greengrass API Reference/greengrass/definition/loggers
{ "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ] }}
Name
The name of the logger definition.
type: stringInitialVersion
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.
287
AWS Greengrass API Reference/greengrass/definition/loggers
type: integer
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
CLI
aws greengrass create-logger-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "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)
DefinitionInformation (p. 464)
{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string"}
DefinitionInformation
Information about a definition.
288
AWS Greengrass API Reference/greengrass/definition/loggers
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
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
required: ["Message"]
289
AWS Greengrass API Reference/greengrass/definition/loggers/LoggerDefinitionId
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: string
/greengrass/definition/loggers/LoggerDefinitionIdGETGET /greengrass/definition/loggers/LoggerDefinitionId
Operation ID: GetLoggerDefinition (p. 130)
Retrieves information about a logger definition.
Produces: application/json
Path Parameters
LoggerDefinitionId (p. 451)
The ID of the logger definition.
where used: path; required: true
type: string
CLI
aws greengrass get-logger-definition \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
290
AWS Greengrass API Reference/greengrass/definition/loggers/LoggerDefinitionId
cli-input-json format:
{ "LoggerDefinitionId": "string"}
Responses
200 (GetLoggerDefinitionResponse)
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.
291
AWS Greengrass API Reference/greengrass/definition/loggers/LoggerDefinitionId
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: string
DELETEDELETE /greengrass/definition/loggers/LoggerDefinitionId
Operation ID: DeleteLoggerDefinition (p. 82)
Deletes a logger definition.
292
AWS Greengrass API Reference/greengrass/definition/loggers/LoggerDefinitionId
Produces: application/json
Path Parameters
LoggerDefinitionId (p. 451)
The ID of the logger definition.
where used: path; required: true
type: string
CLI
aws greengrass delete-logger-definition \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "LoggerDefinitionId": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
293
AWS Greengrass API Reference/greengrass/definition/loggers/LoggerDefinitionId
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: string
PUTPUT /greengrass/definition/loggers/LoggerDefinitionId
Operation ID: UpdateLoggerDefinition (p. 207)
Updates a logger definition.
Produces: application/json
Body Parameters
UpdateDefinitionRequestBody (p. 455)
where used: body; required: true
{ "Name": "string"}
Name
The name of the definition.
294
AWS Greengrass API Reference/greengrass/definition/loggers/LoggerDefinitionId
required: true
type: string
Path Parameters
LoggerDefinitionId (p. 451)
The ID of the logger definition.
where used: path; required: true
type: string
CLI
aws greengrass update-logger-definition \ --logger-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "LoggerDefinitionId": "string", "Name": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string"
295
AWS Greengrass API Reference/greengrass/definition/loggers/
LoggerDefinitionId/versions
} ]}
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: 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.
Produces: application/json
Body Parameters
CreateLoggerDefinitionVersionRequestBody (p. 441)
where used: body; required: true
296
AWS Greengrass API Reference/greengrass/definition/loggers/
LoggerDefinitionId/versions
{ "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ]}
LoggerDefinitionVersion
Information about a logger definition version.
type: object
Loggers
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: string
Type
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: integer
297
AWS Greengrass API Reference/greengrass/definition/loggers/
LoggerDefinitionId/versions
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
LoggerDefinitionId (p. 451)
The ID of the logger definition.
where used: path; required: true
type: string
CLI
aws greengrass create-logger-definition-version \ --logger-definition-id <value> \ [--loggers <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "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 (p. 523)
{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string"}
298
AWS Greengrass API Reference/greengrass/definition/loggers/
LoggerDefinitionId/versions
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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
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)
299
AWS Greengrass API Reference/greengrass/definition/loggers/
LoggerDefinitionId/versions
ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
GETGET /greengrass/definition/loggers/LoggerDefinitionId/versions
Operation ID: ListLoggerDefinitionVersions (p. 175)
Lists the versions of a logger definition.
Produces: application/json
Path Parameters
LoggerDefinitionId (p. 451)
The ID of the logger definition.
where used: path; required: true
type: string
Query Parameters
NextToken (p. 452)
The token for the next set of results, or null if there are no additional results.
where used: query; required: false
type: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
CLI
aws greengrass list-logger-definition-versions \ --logger-definition-id <value> \ [--next-token <value>] \
300
AWS Greengrass API Reference/greengrass/definition/loggers/
LoggerDefinitionId/versions
[--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "LoggerDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}
Responses
200 (ListLoggerDefinitionVersionsResponse)
ListVersionsResponse (p. 504)
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)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.
301
AWS Greengrass API Reference/greengrass/definition/loggers/
LoggerDefinitionId/versions
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
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.
302
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.
Produces: application/json
Path Parameters
LoggerDefinitionVersionId (p. 451)
The ID of the logger definition version.
where used: path; required: true
type: stringLoggerDefinitionId (p. 451)
The ID of the logger definition.
where used: path; required: true
type: string
CLI
aws greengrass get-logger-definition-version \ --logger-definition-version-id <value> \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "LoggerDefinitionVersionId": "string", "LoggerDefinitionId": "string"}
Responses
200 (GetLoggerDefinitionVersionResponse)
success
GetLoggerDefinitionVersionResponse (p. 489)
303
AWS Greengrass API Reference/greengrass/definition/loggers/LoggerDefinitionId/
versions/LoggerDefinitionVersionId
{ "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
Information about a logger definition version.
type: objectArn
The ARN of the logger definition version.
type: stringId
The ID of the logger definition version.
type: stringVersion
The version of the logger definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the logger definition version was created.
type: stringDefinition
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
304
AWS Greengrass API Reference/greengrass/definition/loggers/LoggerDefinitionId/
versions/LoggerDefinitionVersionId
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: integer400
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.
305
AWS Greengrass API Reference/greengrass/definition/resources
type: array
items: ErrorDetail (p. 469)ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
/greengrass/definition/resourcesGETGET /greengrass/definition/resources
Operation ID: ListResourceDefinitions (p. 182)
Retrieves a list of resource definitions.
Produces: application/json
Query Parameters
MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
CLI
aws greengrass list-resource-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
306
AWS Greengrass API Reference/greengrass/definition/resources
{ "MaxResults": "integer", "NextToken": "string"}
Responses
200 (ListResourceDefinitionsResponse)
The IDs of all the Greengrass resource definitions in this account.
ListDefinitionsResponse (p. 499)
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: objectDefinitions
Information about a definition.
type: array
items: DefinitionInformation (p. 464)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: string
307
AWS Greengrass API Reference/greengrass/definition/resources
LastUpdatedTimestamp
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: stringNextToken
The token for the next set of results, or null if there are no additional results.
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.
Produces: application/json
Body Parameters
CreateResourceDefinitionRequestBody (p. 442)
where used: body; required: true
{ "Name": "string", "InitialVersion": { "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" }
308
AWS Greengrass API Reference/greengrass/definition/resources
}, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ] }}
Name
The name of the resource definition.
type: stringInitialVersion
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: string
309
AWS Greengrass API Reference/greengrass/definition/resources
ResourceDataContainer
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: objectAutoAddGroupOwner
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.
type: objectSourcePath
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: stringGroupOwnerSetting
Group owner related settings for local resources.
type: object
310
AWS Greengrass API Reference/greengrass/definition/resources
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: 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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
CLI
aws greengrass create-resource-definition \
311
AWS Greengrass API Reference/greengrass/definition/resources
[--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "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)
DefinitionInformation (p. 464)
{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string"}
312
AWS Greengrass API Reference/greengrass/definition/resources
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
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
313
AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId
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: 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.
Produces: application/json
Path Parameters
ResourceDefinitionId (p. 453)
The ID of the resource definition.
where used: path; required: true
type: string
CLI
aws greengrass get-resource-definition \
314
AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId
--resource-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ResourceDefinitionId": "string"}
Responses
200 (GetResourceDefinitionResponse)
success
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: string
315
AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId
LatestVersion
The latest version of the definition.
type: stringLatestVersionArn
The ARN of the latest version of the definition.
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: string
316
AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId
DELETEDELETE /greengrass/definition/resources/ResourceDefinitionId
Operation ID: DeleteResourceDefinition (p. 84)
Deletes a resource definition.
Produces: application/json
Path Parameters
ResourceDefinitionId (p. 453)
The ID of the resource definition.
where used: path; required: true
type: string
CLI
aws greengrass delete-resource-definition \ --resource-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ResourceDefinitionId": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
invalid request
GeneralError (p. 478)
{
317
AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId
"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: string
PUTPUT /greengrass/definition/resources/ResourceDefinitionId
Operation ID: UpdateResourceDefinition (p. 209)
Updates a resource definition.
Produces: application/json
Body Parameters
UpdateDefinitionRequestBody (p. 455)
where used: body; required: true
318
AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId
{ "Name": "string"}
Name
The name of the definition.
required: true
type: string
Path Parameters
ResourceDefinitionId (p. 453)
The ID of the resource definition.
where used: path; required: true
type: string
CLI
aws greengrass update-resource-definition \ --resource-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ResourceDefinitionId": "string", "Name": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
invalid request
319
AWS Greengrass API Reference/greengrass/definition/resources/
ResourceDefinitionId/versions
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: 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.
320
AWS Greengrass API Reference/greengrass/definition/resources/
ResourceDefinitionId/versions
Produces: application/json
Body Parameters
CreateResourceDefinitionVersionRequestBody (p. 443)
Information about the resource definition version.
where used: body; required: true
{ "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
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
321
AWS Greengrass API Reference/greengrass/definition/resources/
ResourceDefinitionId/versions
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: objectAutoAddGroupOwner
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.
type: object
322
AWS Greengrass API Reference/greengrass/definition/resources/
ResourceDefinitionId/versions
SourcePath
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: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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: 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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
323
AWS Greengrass API Reference/greengrass/definition/resources/
ResourceDefinitionId/versions
type: string
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
ResourceDefinitionId (p. 453)
The ID of the resource definition.
where used: path; required: true
type: string
CLI
aws greengrass create-resource-definition-version \ --resource-definition-id <value> \ [--resources <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "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"
324
AWS Greengrass API Reference/greengrass/definition/resources/
ResourceDefinitionId/versions
}, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ], "AmznClientToken": "string"}
Responses
200 (CreateResourceDefinitionVersionResponse)
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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: string400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ {
325
AWS Greengrass API Reference/greengrass/definition/resources/
ResourceDefinitionId/versions
"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: string
GETGET /greengrass/definition/resources/ResourceDefinitionId/versions
Operation ID: ListResourceDefinitionVersions (p. 180)
Lists the versions of a resource definition.
Produces: application/json
Path Parameters
ResourceDefinitionId (p. 453)
The ID of the resource definition.
where used: path; required: true
326
AWS Greengrass API Reference/greengrass/definition/resources/
ResourceDefinitionId/versions
type: string
Query Parameters
NextToken (p. 452)
The token for the next set of results, or null if there are no additional results.
where used: query; required: false
type: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
CLI
aws greengrass list-resource-definition-versions \ --resource-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ResourceDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}
Responses
200 (ListResourceDefinitionVersionsResponse)
ListVersionsResponse (p. 504)
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}
ListVersionsResponse
A list of versions.
327
AWS Greengrass API Reference/greengrass/definition/resources/
ResourceDefinitionId/versions
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
328
AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId/
versions/ResourceDefinitionVersionId
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: 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.
Produces: application/json
Path Parameters
ResourceDefinitionId (p. 453)
The ID of the resource definition.
where used: path; required: true
type: string
329
AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId/
versions/ResourceDefinitionVersionId
ResourceDefinitionVersionId (p. 453)
The ID of the resource definition version.
where used: path; required: true
type: string
CLI
aws greengrass get-resource-definition-version \ --resource-definition-id <value> \ --resource-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ResourceDefinitionId": "string", "ResourceDefinitionVersionId": "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"
330
AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId/
versions/ResourceDefinitionVersionId
}, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ] }}
GetResourceDefinitionVersionResponse
Information about a resource definition version.
type: objectArn
Arn of the resource definition version.
type: stringId
The ID of the resource definition version.
type: stringVersion
The version of the resource definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the resource definition version was created.
type: stringDefinition
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.
331
AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId/
versions/ResourceDefinitionVersionId
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: objectAutoAddGroupOwner
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.
type: objectSourcePath
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: string
332
AWS Greengrass API Reference/greengrass/definition/resources/ResourceDefinitionId/
versions/ResourceDefinitionVersionId
DestinationPath
The absolute local path of the resource inside the Lambda environment.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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: 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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string400
invalid request
333
AWS Greengrass API Reference/greengrass/definition/subscriptions
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: string
/greengrass/definition/subscriptionsGETGET /greengrass/definition/subscriptions
Operation ID: ListSubscriptionDefinitions (p. 187)
Retrieves a list of subscription definitions.
Produces: application/json
334
AWS Greengrass API Reference/greengrass/definition/subscriptions
Query Parameters
MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
CLI
aws greengrass list-subscription-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "MaxResults": "integer", "NextToken": "string"}
Responses
200 (ListSubscriptionDefinitionsResponse)
ListDefinitionsResponse (p. 499)
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: object
335
AWS Greengrass API Reference/greengrass/definition/subscriptions
Definitions
Information about a definition.
type: array
items: DefinitionInformation (p. 464)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: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string
POSTPOST /greengrass/definition/subscriptions
Operation ID: CreateSubscriptionDefinition (p. 69)
336
AWS Greengrass API Reference/greengrass/definition/subscriptions
Creates a subscription definition. You may provide the initial version of the subscription definition now oruse CreateSubscriptionDefinitionVersion at a later time.
Produces: application/json
Body Parameters
CreateSubscriptionDefinitionRequestBody (p. 447)
where used: body; required: true
{ "Name": "string", "InitialVersion": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }}
Name
The name of the subscription definition.
type: stringInitialVersion
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: string
337
AWS Greengrass API Reference/greengrass/definition/subscriptions
Subject
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
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
CLI
aws greengrass create-subscription-definition \ [--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "Name": "string", "InitialVersion": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }, "AmznClientToken": "string"}
Responses
200 (CreateSubscriptionDefinitionResponse)
DefinitionInformation (p. 464)
{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string",
338
AWS Greengrass API Reference/greengrass/definition/subscriptions
"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
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
339
AWS Greengrass API Reference/greengrass/definition/
subscriptions/SubscriptionDefinitionId
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: string
/greengrass/definition/subscriptions/SubscriptionDefinitionIdGETGET /greengrass/definition/subscriptions/SubscriptionDefinitionId
Operation ID: GetSubscriptionDefinition (p. 144)
Retrieves information about a subscription definition.
Produces: application/json
Path Parameters
SubscriptionDefinitionId (p. 453)
The ID of the subscription definition.
where used: path; required: true
type: string
340
AWS Greengrass API Reference/greengrass/definition/
subscriptions/SubscriptionDefinitionId
CLI
aws greengrass get-subscription-definition \ --subscription-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string"}
Responses
200 (GetSubscriptionDefinitionResponse)
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: string
341
AWS Greengrass API Reference/greengrass/definition/
subscriptions/SubscriptionDefinitionId
LatestVersion
The latest version of the definition.
type: stringLatestVersionArn
The ARN of the latest version of the definition.
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: string
342
AWS Greengrass API Reference/greengrass/definition/
subscriptions/SubscriptionDefinitionId
DELETEDELETE /greengrass/definition/subscriptions/SubscriptionDefinitionId
Operation ID: DeleteSubscriptionDefinition (p. 86)
Deletes a subscription definition.
Produces: application/json
Path Parameters
SubscriptionDefinitionId (p. 453)
The ID of the subscription definition.
where used: path; required: true
type: string
CLI
aws greengrass delete-subscription-definition \ --subscription-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
invalid request
GeneralError (p. 478)
{
343
AWS Greengrass API Reference/greengrass/definition/
subscriptions/SubscriptionDefinitionId
"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: string
PUTPUT /greengrass/definition/subscriptions/SubscriptionDefinitionId
Operation ID: UpdateSubscriptionDefinition (p. 211)
Updates a subscription definition.
Produces: application/json
Body Parameters
UpdateDefinitionRequestBody (p. 455)
where used: body; required: true
344
AWS Greengrass API Reference/greengrass/definition/
subscriptions/SubscriptionDefinitionId
{ "Name": "string"}
Name
The name of the definition.
required: true
type: string
Path Parameters
SubscriptionDefinitionId (p. 453)
The ID of the subscription definition.
where used: path; required: true
type: string
CLI
aws greengrass update-subscription-definition \ --subscription-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string", "Name": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
invalid request
345
AWS Greengrass API Reference/greengrass/definition/subscriptions/
SubscriptionDefinitionId/versions
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: 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.
346
AWS Greengrass API Reference/greengrass/definition/subscriptions/
SubscriptionDefinitionId/versions
Produces: application/json
Body Parameters
CreateSubscriptionDefinitionVersionRequestBody (p. 448)
where used: body; required: true
{ "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ]}
SubscriptionDefinitionVersion
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'.
347
AWS Greengrass API Reference/greengrass/definition/subscriptions/
SubscriptionDefinitionId/versions
type: string
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
SubscriptionDefinitionId (p. 453)
The ID of the subscription definition.
where used: path; required: true
type: string
CLI
aws greengrass create-subscription-definition-version \ --subscription-definition-id <value> \ [--subscriptions <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string", "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ], "AmznClientToken": "string"}
Responses
200 (CreateSubscriptionDefinitionVersionResponse)
VersionInformation (p. 523)
{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string"
348
AWS Greengrass API Reference/greengrass/definition/subscriptions/
SubscriptionDefinitionId/versions
}
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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
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
349
AWS Greengrass API Reference/greengrass/definition/subscriptions/
SubscriptionDefinitionId/versions
items: ErrorDetail (p. 469)ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
GETGET /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions
Operation ID: ListSubscriptionDefinitionVersions (p. 184)
Lists the versions of a subscription definition.
Produces: application/json
Path Parameters
SubscriptionDefinitionId (p. 453)
The ID of the subscription definition.
where used: path; required: true
type: string
Query Parameters
NextToken (p. 452)
The token for the next set of results, or null if there are no additional results.
where used: query; required: false
type: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
CLI
aws greengrass list-subscription-definition-versions \
350
AWS Greengrass API Reference/greengrass/definition/subscriptions/
SubscriptionDefinitionId/versions
--subscription-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string", "NextToken": "string", "MaxResults": "integer"}
Responses
200 (ListSubscriptionDefinitionVersionsResponse)
ListVersionsResponse (p. 504)
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)VersionInformation
Information about a version.
type: objectArn
The ARN of the version.
type: stringId
The ID of the version.
type: string
351
AWS Greengrass API Reference/greengrass/definition/subscriptions/
SubscriptionDefinitionId/versions
Version
The unique ID of the version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
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.
352
AWS Greengrass API Reference/greengrass/definition/subscriptions/
SubscriptionDefinitionId/versions/SubscriptionDefinitionVersionId
type: stringDetailedErrorMessage
A detailed error message.
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.
Produces: application/json
Path Parameters
SubscriptionDefinitionId (p. 453)
The ID of the subscription definition.
where used: path; required: true
type: stringSubscriptionDefinitionVersionId (p. 454)
The ID of the subscription definition version.
where used: path; required: true
type: string
CLI
aws greengrass get-subscription-definition-version \ --subscription-definition-id <value> \ --subscription-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string", "SubscriptionDefinitionVersionId": "string"}
353
AWS Greengrass API Reference/greengrass/definition/subscriptions/
SubscriptionDefinitionId/versions/SubscriptionDefinitionVersionId
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
Information about a subscription definition version.
type: objectArn
The ARN of the subscription definition version.
type: stringId
The ID of the subscription definition version.
type: stringVersion
The version of the subscription definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the subscription definition version was created.
type: stringDefinition
Information about a subscription definition version.
type: objectSubscriptions
A list of subscriptions.
type: array
items: Subscription (p. 520)
354
AWS Greengrass API Reference/greengrass/definition/subscriptions/
SubscriptionDefinitionId/versions/SubscriptionDefinitionVersionId
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: 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: string
355
AWS Greengrass API Reference/greengrass/groups
ErrorDetails
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: string
/greengrass/groups
GETGET /greengrass/groups
Operation ID: ListGroups (p. 173)
Retrieves a list of groups.
Produces: application/json
Query Parameters
MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (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
CLI
aws greengrass list-groups \
356
AWS Greengrass API Reference/greengrass/groups
[--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "MaxResults": "integer", "NextToken": "string"}
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
Information about a group.
type: array
items: GroupInformation (p. 497)
GroupInformation
Information about a group.
type: object
Name
The name of the group.
type: string
Id
The ID of the group.
type: string
357
AWS Greengrass API Reference/greengrass/groups
Arn
The ARN of the group.
type: stringLastUpdatedTimestamp
The time, in milliseconds since the epoch, when the group was last updated.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the group was created.
type: stringLatestVersion
The latest version of the group.
type: stringLatestVersionArn
The ARN of the latest version of the group.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
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.
Produces: application/json
Body Parameters
CreateGroupRequestBody (p. 439)
where used: body; required: true
{ "Name": "string", "InitialVersion": { "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string" }
358
AWS Greengrass API Reference/greengrass/groups
}
Name
The name of the group.
type: stringInitialVersion
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
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
CLI
aws greengrass create-group \
359
AWS Greengrass API Reference/greengrass/groups
[--name <value>] \ [--initial-version <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "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.
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: string
360
AWS Greengrass API Reference/greengrass/groups
LastUpdatedTimestamp
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
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: object
361
AWS Greengrass API Reference/greengrass/groups/GroupId
DetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
/greengrass/groups/GroupId
GETGET /greengrass/groups/GroupId
Operation ID: GetGroup (p. 118)
Retrieves information about a group.
Produces: application/json
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
CLI
aws greengrass get-group \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string"}
Responses
200 (GetGroupResponse)
success
DefinitionInformation (p. 464)
{
362
AWS Greengrass API Reference/greengrass/groups/GroupId
"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
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ {
363
AWS Greengrass API Reference/greengrass/groups/GroupId
"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: string
DELETEDELETE /greengrass/groups/GroupId
Operation ID: DeleteGroup (p. 81)
Deletes a group.
Produces: application/json
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
364
AWS Greengrass API Reference/greengrass/groups/GroupId
type: string
CLI
aws greengrass delete-group \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
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.
365
AWS Greengrass API Reference/greengrass/groups/GroupId
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: string
PUTPUT /greengrass/groups/GroupId
Operation ID: UpdateGroup (p. 201)
Updates a group.
Produces: application/json
Body Parameters
UpdateDefinitionRequestBody (p. 455)
where used: body; required: true
{ "Name": "string"}
Name
The name of the definition.
required: true
type: string
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
366
AWS Greengrass API Reference/greengrass/groups/GroupId
where used: path; required: true
type: string
CLI
aws greengrass update-group \ --group-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "Name": "string"}
Responses
200
success
Empty (p. 469)
{}
Empty Schema
Empty
type: object400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
required: ["Message"]
367
AWS Greengrass API Reference/greengrass/groups/GroupId/certificateauthorities
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: string
/greengrass/groups/GroupId/certificateauthoritiesGETGET /greengrass/groups/GroupId/certificateauthorities
Operation ID: ListGroupCertificateAuthorities (p. 167)
Retrieves the current CAs for a group.
Produces: application/json
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
CLI
aws greengrass list-group-certificate-authorities \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
368
AWS Greengrass API Reference/greengrass/groups/GroupId/certificateauthorities
cli-input-json format:
{ "GroupId": "string"}
Responses
200
Success. The response body contains the PKI Configuration.
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
Information about a certificate authority for a group.
type: objectGroupCertificateAuthorityId
The ID of the certificate authority for the group.
type: stringGroupCertificateAuthorityArn
The ARN of the certificate authority for the group.
type: string400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ {
369
AWS Greengrass API Reference/greengrass/groups/GroupId/certificateauthorities
"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 (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
370
AWS Greengrass API Reference/greengrass/groups/GroupId/certificateauthorities
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: 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.
Produces: application/json
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
371
AWS Greengrass API Reference/greengrass/groups/GroupId/certificateauthorities
type: string
CLI
aws greengrass create-group-certificate-authority \ --group-id <value> \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "AmznClientToken": "string"}
Responses
200
Success. The response body contains the new active CA ARN.
CreateGroupCertificateAuthorityResponse (p. 462)
{ "GroupCertificateAuthorityArn": "string"}
CreateGroupCertificateAuthorityResponse
type: objectGroupCertificateAuthorityArn
The ARN of the group certificate authority.
type: string400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
372
AWS Greengrass API Reference/greengrass/groups/GroupId/certificateauthorities
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 (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.
373
AWS Greengrass API Reference/greengrass/groups/GroupId/
certificateauthorities/configuration/expiry
type: array
items: ErrorDetail (p. 469)ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
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.
Produces: application/json
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
CLI
aws greengrass get-group-certificate-configuration \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string"}
374
AWS Greengrass API Reference/greengrass/groups/GroupId/
certificateauthorities/configuration/expiry
Responses
200
Success. The response body contains the PKI Configuration.
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 (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.
375
AWS Greengrass API Reference/greengrass/groups/GroupId/
certificateauthorities/configuration/expiry
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 (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)
376
AWS Greengrass API Reference/greengrass/groups/GroupId/
certificateauthorities/configuration/expiry
ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
PUTPUT /greengrass/groups/GroupId/certificateauthorities/configuration/expiry
Operation ID: UpdateGroupCertificateConfiguration (p. 203)
Updates the Certificate expiry time for a group.
Produces: application/json
Body Parameters
UpdateGroupCertificateConfigurationRequestBody (p. 456)
where used: body; required: true
{ "CertificateExpiryInMilliseconds": "string"}
updateGroupCertificateConfigurationRequest
type: object
required: ["CertificateExpiryInMilliseconds"]CertificateExpiryInMilliseconds
The amount of time remaining before the certificate expires, in milliseconds.
type: string
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
377
AWS Greengrass API Reference/greengrass/groups/GroupId/
certificateauthorities/configuration/expiry
CLI
aws greengrass update-group-certificate-configuration \ --group-id <value> \ [--certificate-expiry-in-milliseconds <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "CertificateExpiryInMilliseconds": "string"}
Responses
200
Success. The response body contains the PKI Configuration.
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 (p. 478)
{ "Message": "string", "ErrorDetails": [
378
AWS Greengrass API Reference/greengrass/groups/GroupId/
certificateauthorities/configuration/expiry
{ "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 (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
379
AWS Greengrass API Reference/greengrass/groups/GroupId/
certificateauthorities/CertificateAuthorityId
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: 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.
Produces: application/json
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: stringCertificateAuthorityId (p. 431)
The ID of the certificate authority.
380
AWS Greengrass API Reference/greengrass/groups/GroupId/
certificateauthorities/CertificateAuthorityId
where used: path; required: true
type: string
CLI
aws greengrass get-group-certificate-authority \ --group-id <value> \ --certificate-authority-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "CertificateAuthorityId": "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: objectPemEncodedCertificate
The PEM encoded certificate for the group.
type: stringGroupCertificateAuthorityArn
The ARN of the certificate authority for the group.
type: stringGroupCertificateAuthorityId
The ID of the certificate authority for the group.
type: string400
invalid request
GeneralError (p. 478)
381
AWS Greengrass API Reference/greengrass/groups/GroupId/
certificateauthorities/CertificateAuthorityId
{ "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 (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
382
AWS Greengrass API Reference/greengrass/groups/GroupId/deployments
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: string
/greengrass/groups/GroupId/deploymentsPOSTPOST /greengrass/groups/GroupId/deployments
Operation ID: CreateDeployment (p. 15)
Creates a deployment.
Produces: application/json
Body Parameters
CreateDeploymentRequestBody (p. 433)
where used: body; required: true
{ "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string"}
383
AWS Greengrass API Reference/greengrass/groups/GroupId/deployments
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: string
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
CLI
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]
cli-input-json format:
{
384
AWS Greengrass API Reference/greengrass/groups/GroupId/deployments
"GroupId": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string", "AmznClientToken": "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
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.
385
AWS Greengrass API Reference/greengrass/groups/GroupId/deployments
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: string
GETGET /greengrass/groups/GroupId/deployments
Operation ID: ListDeployments (p. 155)
Returns a history of deployments for the group.
Produces: application/json
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
Query Parameters
MaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
type: integerNextToken (p. 452)
The token for the next set of results, or null if there are no additional results.
where used: query; required: false
386
AWS Greengrass API Reference/greengrass/groups/GroupId/deployments
type: string
CLI
aws greengrass list-deployments \ --group-id <value> \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "MaxResults": "integer", "NextToken": "string"}
Responses
200
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"}
ListDeploymentsResponse
type: objectDeployments
type: array
items: Deployment (p. 465)Deployment
Information about a deployment.
type: objectGroupArn
The ARN of the group for this deployment.
type: string
387
AWS Greengrass API Reference/greengrass/groups/GroupId/deployments
DeploymentId
The ID of the deployment.
type: stringDeploymentArn
The ARN of the deployment.
type: stringDeploymentType
type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]CreatedAt
The time, in milliseconds since the epoch, when the deployment was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
in: query
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
388
AWS Greengrass API Reference/greengrass/groups/GroupId/deployments/$reset
items: ErrorDetail (p. 469)ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
/greengrass/groups/GroupId/deployments/$resetPOSTPOST /greengrass/groups/GroupId/deployments/$reset
Operation ID: ResetDeployments (p. 189)
Resets a group's deployments.
Produces: application/json
Body Parameters
ResetDeploymentsRequestBody (p. 452)
Information needed to reset deployments.
where used: body; required: true
{ "Force": true}
ResetDeploymentsRequest
Information about a group reset request.
type: objectForce
If true, performs a best-effort only core reset.
type: boolean
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
389
AWS Greengrass API Reference/greengrass/groups/GroupId/deployments/$reset
where used: header; required: false
type: string
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
CLI
aws greengrass reset-deployments \ --group-id <value> \ [--force | --no-force] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "Force": "boolean", "AmznClientToken": "string"}
Responses
200
Success. The group's deployments were reset.
ResetDeploymentsResponse (p. 510)
{ "DeploymentArn": "string", "DeploymentId": "string"}
ResetDeploymentsResponse
type: objectDeploymentArn
The ARN of the deployment.
type: stringDeploymentId
The ID of the deployment.
type: string
390
AWS Greengrass API Reference/greengrass/groups/GroupId/
deployments/DeploymentId/status
400
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: string
/greengrass/groups/GroupId/deployments/DeploymentId/statusGETGET /greengrass/groups/GroupId/deployments/DeploymentId/status
391
AWS Greengrass API Reference/greengrass/groups/GroupId/
deployments/DeploymentId/status
Operation ID: GetDeploymentStatus (p. 103)
Returns the status of a deployment.
Produces: application/json
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: stringDeploymentId (p. 449)
The ID of the deployment.
where used: path; required: true
type: string
CLI
aws greengrass get-deployment-status \ --group-id <value> \ --deployment-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "DeploymentId": "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" } ]}
392
AWS Greengrass API Reference/greengrass/groups/GroupId/
deployments/DeploymentId/status
GetDeploymentStatusResponse
Information about the status of a deployment for a group.
type: objectDeploymentStatus
The status of the deployment.
type: stringDeploymentType
type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]UpdatedAt
The time, in milliseconds since the epoch, when the deployment status was updated.
type: stringErrorMessage
Error message
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: string400
invalid request
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string",
393
AWS Greengrass API Reference/greengrass/groups/GroupId/role
"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: 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)
where used: body; required: true
394
AWS Greengrass API Reference/greengrass/groups/GroupId/role
{ "RoleArn": "string"}
AssociateRoleToGroupRequest
type: object
required: ["RoleArn"]RoleArn
The ARN of the role you wish to associate with this group.
type: string
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
CLI
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"}
Responses
200
success
AssociateRoleToGroupResponse (p. 496)
{ "AssociatedAt": "string"}
Group
type: object
395
AWS Greengrass API Reference/greengrass/groups/GroupId/role
AssociatedAt
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 (p. 478)
396
AWS Greengrass API Reference/greengrass/groups/GroupId/role
{ "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: string
DELETEDELETE /greengrass/groups/GroupId/role
Operation ID: DisassociateRoleFromGroup (p. 88)
Disassociates the role from a group.
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
397
AWS Greengrass API Reference/greengrass/groups/GroupId/role
where used: path; required: true
type: string
CLI
aws greengrass disassociate-role-from-group \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "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
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
398
AWS Greengrass API Reference/greengrass/groups/GroupId/role
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 (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.
399
AWS Greengrass API Reference/greengrass/groups/GroupId/role
type: array
items: ErrorDetail (p. 469)ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
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)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
CLI
aws greengrass get-associated-role \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string"}
Responses
200
success
GetAssociatedRoleResponse (p. 479)
400
AWS Greengrass API Reference/greengrass/groups/GroupId/role
{ "AssociatedAt": "string", "RoleArn": "string"}
GetAssociatedRoleResponse
type: objectAssociatedAt
The time when the role was associated with the group.
type: stringRoleArn
The ARN of the role that is 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: object
401
AWS Greengrass API Reference/greengrass/groups/GroupId/role
DetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string500
server error
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: string
402
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.
Produces: application/json
Body Parameters
CreateGroupVersionRequestBody (p. 440)
where used: body; required: true
{ "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string"}
GroupVersion
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: string
403
AWS Greengrass API Reference/greengrass/groups/GroupId/versions
ResourceDefinitionVersionArn
The resource definition version ARN for this group.
type: string
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
CLI
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]
cli-input-json format:
{ "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.
404
AWS Greengrass API Reference/greengrass/groups/GroupId/versions
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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
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.
405
AWS Greengrass API Reference/greengrass/groups/GroupId/versions
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: string
GETGET /greengrass/groups/GroupId/versions
Operation ID: ListGroupVersions (p. 170)
Lists the versions of a group.
Produces: application/json
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: string
Query Parameters
NextToken (p. 452)
The token for the next set of results, or null if there are no additional results.
where used: query; required: false
type: stringMaxResults (p. 452)
The maximum number of results to be returned per request.
where used: query; required: false
406
AWS Greengrass API Reference/greengrass/groups/GroupId/versions
type: integer
CLI
aws greengrass list-group-versions \ --group-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "NextToken": "string", "MaxResults": "integer"}
Responses
200 (ListGroupVersionsResponse)
Success. The response contains the list of versions and metadata for the given group.
ListVersionsResponse (p. 504)
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)VersionInformation
Information about a version.
type: objectArn
The ARN of the version.
407
AWS Greengrass API Reference/greengrass/groups/GroupId/versions
type: stringId
The ID of the version.
type: stringVersion
The unique ID of the version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
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.
408
AWS Greengrass API Reference/greengrass/groups/GroupId/versions/GroupVersionId
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
/greengrass/groups/GroupId/versions/GroupVersionIdGETGET /greengrass/groups/GroupId/versions/GroupVersionId
Operation ID: GetGroupVersion (p. 127)
Retrieves information about a group version.
Produces: application/json
Path Parameters
GroupId (p. 450)
The ID of the AWS Greengrass group.
where used: path; required: true
type: stringGroupVersionId (p. 451)
The ID of the group version.
where used: path; required: true
type: string
CLI
aws greengrass get-group-version \ --group-id <value> \ --group-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "GroupVersionId": "string"
409
AWS Greengrass API Reference/greengrass/groups/GroupId/versions/GroupVersionId
}
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
Information about a group version.
type: objectArn
The ARN of the group version.
type: stringId
The ID of the group version.
type: stringVersion
The unique ID for the version of the group.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the group version was created.
type: stringDefinition
Information about a group version.
type: objectCoreDefinitionVersionArn
The ARN of the core definition version for this group.
type: string
410
AWS Greengrass API Reference/greengrass/groups/GroupId/versions/GroupVersionId
DeviceDefinitionVersionArn
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: 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)
411
AWS Greengrass API Reference/greengrass/servicerole
ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
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)
where used: body; required: true
{ "RoleArn": "string"}
AssociateServiceRoleToAccountRequest
type: object
required: ["RoleArn"]RoleArn
The ARN of the service role you wish to associate with your account.
type: string
CLI
aws greengrass associate-service-role-to-account \ [--role-arn <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
412
AWS Greengrass API Reference/greengrass/servicerole
cli-input-json format:
{ "RoleArn": "string"}
Responses
200
success
AssociateServiceRoleToAccountResponse (p. 459)
{ "AssociatedAt": "string"}
AssociateServiceRoleToAccountResponse
type: objectAssociatedAt
The time when the service role was associated with the account.
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
413
AWS Greengrass API Reference/greengrass/servicerole
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 (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.
414
AWS Greengrass API Reference/greengrass/servicerole
type: stringDetailedErrorMessage
A detailed error message.
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.
CLI
aws greengrass disassociate-service-role-from-account \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
Responses
200
success
DisassociateServiceRoleFromAccountResponse (p. 469)
{ "DisassociatedAt": "string"}
DisassociateServiceRoleFromAccountResponse
type: objectDisassociatedAt
The time when the service role was disassociated from the account.
type: string500
server error
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
415
AWS Greengrass API Reference/greengrass/servicerole
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: string
GETGET /greengrass/servicerole
Operation ID: GetServiceRoleForAccount (p. 143)
Retrieves the service role that is attached to your account.
CLI
aws greengrass get-service-role-for-account \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
Responses
200
success
GetServiceRoleForAccountResponse (p. 494)
416
AWS Greengrass API Reference/greengrass/servicerole
{ "AssociatedAt": "string", "RoleArn": "string"}
GetServiceRoleForAccountResponse
type: objectAssociatedAt
The time when the service role was associated with the account.
type: stringRoleArn
The ARN of the role which is associated with the account.
type: string500
server error
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: object
417
AWS Greengrass API Reference/greengrass/things/ThingName/connectivityInfo
DetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
type: string
/greengrass/things/ThingName/connectivityInfo
GETGET /greengrass/things/ThingName/connectivityInfo
Operation ID: GetConnectivityInfo (p. 94)
Retrieves the connectivity information for a core.
Produces: application/json
Path Parameters
ThingName (p. 454)
The thing name.
where used: path; required: true
type: string
CLI
aws greengrass get-connectivity-info \ --thing-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ThingName": "string"}
Responses
200
success
GetConnectivityInfoResponse (p. 479)
{
418
AWS Greengrass API Reference/greengrass/things/ThingName/connectivityInfo
"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 (p. 478)
{
419
AWS Greengrass API Reference/greengrass/things/ThingName/connectivityInfo
"Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
required: ["Message"]
Message
A message containing information about the error.
type: string
ErrorDetails
A list of error details.
type: array
items: ErrorDetail (p. 469)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
500
server error
GeneralError (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
420
AWS Greengrass API Reference/greengrass/things/ThingName/connectivityInfo
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: 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.
Produces: application/json
Body Parameters
UpdateConnectivityInfoRequestBody (p. 454)
The connectivity information.
where used: body; required:
{ "ConnectivityInfo": [ { "Id": "string",
421
AWS Greengrass API Reference/greengrass/things/ThingName/connectivityInfo
"HostAddress": "string", "PortNumber": 0x01, "Metadata": "string" } ]}
Information required to update a Greengrass core's connectivity.ConnectivityInfo
A list of connectivity info.
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: string
Path Parameters
ThingName (p. 454)
The thing name.
where used: path; required: true
type: string
CLI
aws greengrass update-connectivity-info \ --thing-name <value> \ [--connectivity-info <value>] \
422
AWS Greengrass API Reference/greengrass/things/ThingName/connectivityInfo
[--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ThingName": "string", "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": "int32-integer", "Metadata": "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 (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
423
AWS Greengrass API Reference/greengrass/things/ThingName/connectivityInfo
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 (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: string
424
AWS Greengrass API Reference/greengrass/updates
ErrorDetails
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: 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.
Produces: application/json
Body Parameters
CreateSoftwareUpdateJobRequestBody (p. 446)
where used: body; required: true
{ "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
Request for the CreateSoftwareUpdateJob API.
425
AWS Greengrass API Reference/greengrass/updates
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"]
Header Parameters
X-Amzn-Client-Token (p. 456)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
CLI
aws greengrass create-software-update-job \
426
AWS Greengrass API Reference/greengrass/updates
[--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]
cli-input-json format:
{ "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
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 (p. 478)
{ "Message": "string", "ErrorDetails": [
427
AWS Greengrass API Reference/greengrass/updates
{ "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 (p. 478)
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
428
AWS Greengrass API ReferenceParameters
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: 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)
429
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
required: ["RoleArn"]RoleArn
The ARN of the role you wish to associate with this group.
type: string
430
AWS Greengrass API ReferenceAssociateServiceRoleToAccountRequestBody
AssociateServiceRoleToAccountRequestBody{ "RoleArn": "string"}
AssociateServiceRoleToAccountRequestBody
in: body
required: true
schema: AssociateServiceRoleToAccountRequest (p. 459)AssociateServiceRoleToAccountRequest
type: object
required: ["RoleArn"]RoleArn
The ARN of the service role you wish to associate with your account.
type: string
CertificateAuthorityId{ "CertificateAuthorityId": "string"}
CertificateAuthorityId
The ID of the certificate authority.
in: path
required: true
type: string
CoreDefinitionId{ "CoreDefinitionId": "string"}
CoreDefinitionId
The ID of the core definition.
in: path
required: true
type: string
431
AWS Greengrass API ReferenceCoreDefinitionVersionId
CoreDefinitionVersionId{ "CoreDefinitionVersionId": "string"}
CoreDefinitionVersionId
The ID of the core definition version.
in: path
required: true
type: string
CreateCoreDefinitionRequestBody{ "Name": "string", "InitialVersion": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}
CreateCoreDefinitionRequestBody
Information needed to create a core definition.
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",
432
AWS Greengrass API ReferenceCreateDeploymentRequestBody
"SyncShadow": true } ]}
CreateCoreDefinitionVersionRequestBody
in: body
required: true
schema: CoreDefinitionVersion (p. 460)CoreDefinitionVersion
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: boolean
CreateDeploymentRequestBody{
433
AWS Greengrass API ReferenceCreateDeviceDefinitionRequestBody
"DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string"}
CreateDeploymentRequestBody
in: body
required: true
schema: CreateDeploymentRequest (p. 461)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: string
CreateDeviceDefinitionRequestBody{ "Name": "string", "InitialVersion": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }}
CreateDeviceDefinitionRequestBody
Information needed to create a device definition.
in: body
required: true
434
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
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
required: ["Id", "ThingArn", "CertificateArn"]Id
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: stringThingArn
The thing ARN of the device.
type: string
435
AWS Greengrass API ReferenceCreateFunctionDefinitionRequestBody
CertificateArn
The ARN of the certificate associated with the device.
type: stringSyncShadow
If true, the device's local shadow will be automatically synced with the cloud.
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
required: trueproperties
Name: "description"=>"The name of the function definition.","type"=>"string"
InitialVersion: "$ref"=>"#/definitions/FunctionDefinitionVersion","description"=>"Information about the initial version of the functiondefinition."
436
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
Information about the function definition version.
in: body
required: true
schema: FunctionDefinitionVersion (p. 475)FunctionDefinitionVersion
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"]
437
AWS Greengrass API ReferenceCreateFunctionDefinitionVersionRequestBody
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: booleanExecutable
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.
438
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)
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 resource definiton.)
type: string
Permission
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 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
439
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
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.
440
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)
LoggerDefinitionVersion
Information about a logger definition version.
441
AWS Greengrass API ReferenceCreateResourceDefinitionRequestBody
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 logger definitionversion. 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: 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"
442
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
required: trueproperties
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" }
443
AWS Greengrass API ReferenceCreateResourceDefinitionVersionRequestBody
}, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ]}
CreateResourceDefinitionVersionRequestBody
Information about the resource definition version.
in: body
required: true
schema: ResourceDefinitionVersion (p. 515)ResourceDefinitionVersion
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 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: stringResourceDataContainer
A container for resource data. The container takes only one of thefollowing supported resource data types: LocalDeviceResourceData,LocalVolumeResourceData, SageMakerMachineLearningModelResourceData,S3MachineLearningModelResourceData.
444
AWS Greengrass API ReferenceCreateResourceDefinitionVersionRequestBody
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 refer onlyto a character device or block device under /dev.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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.
type: booleanGroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
type: stringLocalVolumeResourceData
Attributes that define a local volume resource.
type: objectSourcePath
The local absolute path of the volume resource on the host. The source path for a volume resourcetype cannot start with /proc or /sys.
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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.
445
AWS Greengrass API ReferenceCreateSoftwareUpdateJobRequestBody
type: booleanGroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
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.gz or .zipformat.
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
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
446
AWS Greengrass API ReferenceCreateSubscriptionDefinitionRequestBody
schema: CreateSoftwareUpdateJobRequest (p. 463)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 an update.
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"]
CreateSubscriptionDefinitionRequestBody{ "Name": "string", "InitialVersion": { "Subscriptions": [ { "Id": "string", "Source": "string",
447
AWS Greengrass API ReferenceCreateSubscriptionDefinitionVersionRequestBody
"Subject": "string", "Target": "string" } ] }}
CreateSubscriptionDefinitionRequestBody
in: body
required: trueproperties
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
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
448
AWS Greengrass API ReferenceDeploymentId
required: ["Id", "Source", "Subject", "Target"]Id
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
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' (which representsthe AWS IoT cloud), or 'GGShadowService'.
type: string
DeploymentId{ "DeploymentId": "string"}
DeploymentId
The ID of the deployment.
in: path
required: true
type: string
DeviceDefinitionId{ "DeviceDefinitionId": "string"}
DeviceDefinitionId
The ID of the device definition.
in: path
required: true
type: string
449
AWS Greengrass API ReferenceDeviceDefinitionVersionId
DeviceDefinitionVersionId{ "DeviceDefinitionVersionId": "string"}
DeviceDefinitionVersionId
The ID of the device definition version.
in: path
required: true
type: string
FunctionDefinitionId{ "FunctionDefinitionId": "string"}
FunctionDefinitionId
The ID of the Lambda function definition.
in: path
required: true
type: string
FunctionDefinitionVersionId{ "FunctionDefinitionVersionId": "string"}
FunctionDefinitionVersionId
The ID of the function definition version.
in: path
required: true
type: string
GroupId{ "GroupId": "string"
450
AWS Greengrass API ReferenceGroupVersionId
}
GroupId
The ID of the AWS Greengrass group.
in: path
required: true
type: string
GroupVersionId{ "GroupVersionId": "string"}
GroupVersionId
The ID of the group version.
in: path
required: true
type: string
LoggerDefinitionId{ "LoggerDefinitionId": "string"}
LoggerDefinitionId
The ID of the logger definition.
in: path
required: true
type: string
LoggerDefinitionVersionId{ "LoggerDefinitionVersionId": "string"}
LoggerDefinitionVersionId
The ID of the logger definition version.
451
AWS Greengrass API ReferenceMaxResults
in: path
required: true
type: string
MaxResults{ "MaxResults": 100}
MaxResults
The maximum number of results to be returned per request.
in: query
required: false
min: 1
max: 250
default: 250
type: integer
NextToken{ "NextToken": "string"}
NextToken
The token for the next set of results, or null if there are no additional results.
in: query
required: false
type: string
ResetDeploymentsRequestBody{ "Force": true}
ResetDeploymentsRequestBody
Information needed to reset deployments.
452
AWS Greengrass API ReferenceResourceDefinitionId
in: body
required: true
schema: ResetDeploymentsRequest (p. 509)ResetDeploymentsRequest
Information about a group reset request.
type: objectForce
If true, performs a best-effort only core reset.
type: boolean
ResourceDefinitionId{ "ResourceDefinitionId": "string"}
ResourceDefinitionId
The ID of the resource definition.
in: path
required: true
type: string
ResourceDefinitionVersionId{ "ResourceDefinitionVersionId": "string"}
ResourceDefinitionVersionId
The ID of the resource definition version.
in: path
required: true
type: string
SubscriptionDefinitionId{ "SubscriptionDefinitionId": "string"}
453
AWS Greengrass API ReferenceSubscriptionDefinitionVersionId
SubscriptionDefinitionId
The ID of the subscription definition.
in: path
required: true
type: string
SubscriptionDefinitionVersionId{ "SubscriptionDefinitionVersionId": "string"}
SubscriptionDefinitionVersionId
The ID of the subscription definition version.
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" } ]}
454
AWS Greengrass API ReferenceUpdateDefinitionRequestBody
UpdateConnectivityInfoRequestBody
The connectivity information.
in: body
schema: UpdateConnectivityInfoRequest (p. 521)
Information required to update a Greengrass core's connectivity.ConnectivityInfo
A list of connectivity info.
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: string
UpdateDefinitionRequestBody{ "Name": "string"}
UpdateDefinitionRequestBody
in: body
required: trueproperties
Name: "description"=>"The name of the definition.", "required"=>true,"type"=>"string"
455
AWS Greengrass API ReferenceUpdateGroupCertificateConfigurationRequestBody
UpdateGroupCertificateConfigurationRequestBody{ "CertificateExpiryInMilliseconds": "string"}
UpdateGroupCertificateConfigurationRequestBody
in: body
required: true
schema: UpdateGroupCertificateConfigurationRequest (p. 525)
updateGroupCertificateConfigurationRequest
type: object
required: ["CertificateExpiryInMilliseconds"]
CertificateExpiryInMilliseconds
The amount of time remaining before the certificate expires, in milliseconds.
type: string
X-Amzn-Client-Token{ "X-Amzn-Client-Token": "string"}
X-Amzn-Client-Token
A client token used to correlate requests and responses.
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)
456
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)
457
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
required: ["RoleArn"]RoleArn
The ARN of the role you wish to associate with this group.
type: string
458
AWS Greengrass API ReferenceAssociateServiceRoleToAccountRequest
AssociateServiceRoleToAccountRequest{ "RoleArn": "string"}
AssociateServiceRoleToAccountRequest
type: object
required: ["RoleArn"]RoleArn
The ARN of the service role you wish to associate with your account.
type: string
AssociateServiceRoleToAccountResponse{ "AssociatedAt": "string"}
AssociateServiceRoleToAccountResponse
type: objectAssociatedAt
The time when the service role was associated with the account.
type: string
ConnectivityInfo{ "Id": "string", "HostAddress": "string", "PortNumber": 0x01, "Metadata": "string"}
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.
459
AWS Greengrass API ReferenceCore
type: stringPortNumber
The port of the Greengrass core. Usually 8883.
type: integer
format: int32Metadata
Metadata for this endpoint.
type: string
Core{ "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true}
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: boolean
CoreDefinitionVersion{
460
AWS Greengrass API ReferenceCreateDeploymentRequest
"Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}
CoreDefinitionVersion
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: boolean
CreateDeploymentRequest{ "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string"
461
AWS Greengrass API ReferenceCreateDeploymentResponse
}
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: string
CreateDeploymentResponse{ "DeploymentArn": "string", "DeploymentId": "string"}
CreateDeploymentResponse
type: objectDeploymentArn
The ARN of the deployment.
type: stringDeploymentId
The ID of the deployment.
type: string
CreateGroupCertificateAuthorityResponse{ "GroupCertificateAuthorityArn": "string"}
CreateGroupCertificateAuthorityResponse
type: object
462
AWS Greengrass API ReferenceCreateSoftwareUpdateJobRequest
GroupCertificateAuthorityArn
The ARN of the group certificate authority.
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
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 an update.
type: string
463
AWS Greengrass API ReferenceCreateSoftwareUpdateJobResponse
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"]
CreateSoftwareUpdateJobResponse{ "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: string
DefinitionInformation{ "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.
464
AWS Greengrass API ReferenceDeployment
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: string
Deployment{ "GroupArn": "string", "DeploymentId": "string", "DeploymentArn": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "CreatedAt": "string"}
Deployment
Information about a deployment.
type: objectGroupArn
The ARN of the group for this deployment.
type: stringDeploymentId
The ID of the deployment.
type: stringDeploymentArn
The ARN of the deployment.
type: string
465
AWS Greengrass API ReferenceDeploymentType
DeploymentType
type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]CreatedAt
The time, in milliseconds since the epoch, when the deployment was created.
type: string
DeploymentType{}
type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]
Deployments[ { "GroupArn": "string", "DeploymentId": "string", "DeploymentArn": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "CreatedAt": "string" }]
type: array
items: Deployment (p. 465)Deployment
Information about a deployment.
type: objectGroupArn
The ARN of the group for this deployment.
type: stringDeploymentId
The ID of the deployment.
type: stringDeploymentArn
The ARN of the deployment.
466
AWS Greengrass API ReferenceDevice
type: stringDeploymentType
type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]CreatedAt
The time, in milliseconds since the epoch, when the deployment was created.
type: string
Device{ "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true}
Device
Information about a device.
type: object
required: ["Id", "ThingArn", "CertificateArn"]Id
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: stringThingArn
The thing ARN of the device.
type: stringCertificateArn
The ARN of the certificate associated with the device.
type: stringSyncShadow
If true, the device's local shadow will be automatically synced with the cloud.
type: boolean
DeviceDefinitionVersion{ "Devices": [ { "Id": "string",
467
AWS Greengrass API ReferenceDisassociateRoleFromGroupResponse
"ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ]}
DeviceDefinitionVersion
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
required: ["Id", "ThingArn", "CertificateArn"]Id
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: stringThingArn
The thing ARN of the device.
type: stringCertificateArn
The ARN of the certificate associated with the device.
type: stringSyncShadow
If true, the device's local shadow will be automatically synced with the cloud.
type: boolean
DisassociateRoleFromGroupResponse{ "DisassociatedAt": "string"}
DisassociateRoleFromGroupResponse
type: object
468
AWS Greengrass API ReferenceDisassociateServiceRoleFromAccountResponse
DisassociatedAt
The time, in milliseconds since the epoch, when the role was disassociated from the group.
type: string
DisassociateServiceRoleFromAccountResponse{ "DisassociatedAt": "string"}
DisassociateServiceRoleFromAccountResponse
type: objectDisassociatedAt
The time when the service role was disassociated from the account.
type: string
Empty Schema{}
Empty Schema
Empty
type: object
ErrorDetail{ "DetailedErrorCode": "string", "DetailedErrorMessage": "string"}
ErrorDetail
Details about the error.
type: objectDetailedErrorCode
A detailed error code.
type: stringDetailedErrorMessage
A detailed error message.
469
AWS Greengrass API ReferenceErrorDetails
type: string
ErrorDetails[ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" }]
ErrorDetails
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: 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" }
470
AWS Greengrass API ReferenceFunction
], "AccessSysfs": true } }}
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: booleanExecutable
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.
471
AWS Greengrass API ReferenceFunctionConfiguration
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 granted access.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 resource definiton.)
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 the Lambdafunction needs to read device information from /sys.
type: boolean
FunctionConfiguration{ "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0,
472
AWS Greengrass API ReferenceFunctionConfiguration
"EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true }}
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: booleanExecutable
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: object
473
AWS Greengrass API ReferenceFunctionConfigurationEnvironment
Variables
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 granted access.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 resource definiton.)
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 the Lambdafunction needs to read device information from /sys.
type: boolean
FunctionConfigurationEnvironment{ "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true}
474
AWS Greengrass API ReferenceFunctionDefinitionVersion
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 granted access.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 resource definiton.)
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 the Lambdafunction needs to read device information from /sys.
type: boolean
FunctionDefinitionVersion{ "Functions": [ { "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0,
475
AWS Greengrass API ReferenceFunctionDefinitionVersion
"EncodingType": "binary|json", "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "ResourceAccessPolicies": [ { "ResourceId": "string", "Permission": "ro|rw" } ], "AccessSysfs": true } } } ]}
FunctionDefinitionVersion
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
476
AWS Greengrass API ReferenceFunctionDefinitionVersion
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 granted access.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 resource definiton.)
477
AWS Greengrass API ReferenceGeneralError
type: string
Permission
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 the Lambdafunction needs to read device information from /sys.
type: boolean
GeneralError{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ]}
GeneralError
General error information.
type: object
required: ["Message"]
Message
A message containing information about the error.
type: string
ErrorDetails
A list of error details.
type: array
items: ErrorDetail (p. 469)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
478
AWS Greengrass API ReferenceGetAssociatedRoleResponse
DetailedErrorMessage
A detailed error message.
type: string
GetAssociatedRoleResponse{ "AssociatedAt": "string", "RoleArn": "string"}
GetAssociatedRoleResponse
type: objectAssociatedAt
The time when the role was associated with the group.
type: stringRoleArn
The ARN of the role that is associated with the group.
type: string
GetConnectivityInfoResponse{ "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)
479
AWS Greengrass API ReferenceGetCoreDefinitionVersionResponse
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: string
GetCoreDefinitionVersionResponse{ "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
The ID of the core definition version.
480
AWS Greengrass API ReferenceGetDeploymentStatusResponse
type: stringVersion
The version of the core definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the core definition version was created.
type: stringDefinition
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: boolean
GetDeploymentStatusResponse{ "DeploymentStatus": "string",
481
AWS Greengrass API ReferenceGetDeploymentStatusResponse
"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: objectDeploymentStatus
The status of the deployment.
type: stringDeploymentType
type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]UpdatedAt
The time, in milliseconds since the epoch, when the deployment status was updated.
type: stringErrorMessage
Error message
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: string
482
AWS Greengrass API ReferenceGetDeviceDefinitionVersionResponse
GetDeviceDefinitionVersionResponse{ "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
The ID of the device definition version.
type: stringVersion
The version of the device definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the device definition version was created.
type: stringDefinition
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
483
AWS Greengrass API ReferenceGetFunctionDefinitionVersionResponse
required: ["Id", "ThingArn", "CertificateArn"]Id
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: stringThingArn
The thing ARN of the device.
type: stringCertificateArn
The ARN of the certificate associated with the device.
type: stringSyncShadow
If true, the device's local shadow will be automatically synced with the cloud.
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 } } } ] }
484
AWS Greengrass API ReferenceGetFunctionDefinitionVersionResponse
}
GetFunctionDefinitionVersionResponse
Information about a function definition version.
type: objectArn
The ARN of the function definition version.
type: stringId
The ID of the function definition version.
type: stringVersion
The version of the function definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the function definition version was created.
type: stringDefinition
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.
485
AWS Greengrass API ReferenceGetFunctionDefinitionVersionResponse
type: objectPinned
True if the function is pinned. Pinned means the function is long-lived and starts when the corestarts.
type: booleanExecutable
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 granted access.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.
486
AWS Greengrass API ReferenceGetGroupCertificateAuthorityResponse
type: object
required: ["ResourceId"]ResourceId
The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)
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 the Lambdafunction needs to read device information from /sys.
type: boolean
GetGroupCertificateAuthorityResponse{ "PemEncodedCertificate": "string", "GroupCertificateAuthorityArn": "string", "GroupCertificateAuthorityId": "string"}
GetGroupCertificateAuthorityResponse
Information about a certificate authority for a group.
type: objectPemEncodedCertificate
The PEM encoded certificate for the group.
type: stringGroupCertificateAuthorityArn
The ARN of the certificate authority for the group.
type: stringGroupCertificateAuthorityId
The ID of the certificate authority for the group.
type: string
GetGroupVersionResponse{
487
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" }}
GetGroupVersionResponse
Information about a group version.
type: objectArn
The ARN of the group version.
type: stringId
The ID of the group version.
type: stringVersion
The unique ID for the version of the group.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the group version was created.
type: stringDefinition
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: string
488
AWS Greengrass API ReferenceGetLoggerDefinitionVersionResponse
SubscriptionDefinitionVersionArn
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
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 } ] }}
GetLoggerDefinitionVersionResponse
Information about a logger definition version.
type: objectArn
The ARN of the logger definition version.
type: stringId
The ID of the logger definition version.
type: stringVersion
The version of the logger definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the logger definition version was created.
489
AWS Greengrass API ReferenceGetResourceDefinitionVersionResponse
type: stringDefinition
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 logger definitionversion. 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: integer
GetResourceDefinitionVersionResponse{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Resources": [ { "Id": "string",
490
AWS Greengrass API ReferenceGetResourceDefinitionVersionResponse
"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
Information about a resource definition version.
type: objectArn
Arn of the resource definition version.
type: stringId
The ID of the resource definition version.
type: stringVersion
The version of the resource definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the resource definition version was created.
type: stringDefinition
Information about a resource definition version.
type: object
491
AWS Greengrass API ReferenceGetResourceDefinitionVersionResponse
Resources
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 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: 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 refer onlyto a character device or block device under /dev.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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.
type: boolean
492
AWS Greengrass API ReferenceGetResourceDefinitionVersionResponse
GroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
type: stringLocalVolumeResourceData
Attributes that define a local volume resource.
type: objectSourcePath
The local absolute path of the volume resource on the host. The source path for a volume resourcetype cannot start with /proc or /sys.
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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.
type: booleanGroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: stringS3MachineLearningModelResourceData
Attributes that define an Amazon S3 machine learning resource.
type: object
493
AWS Greengrass API ReferenceGetServiceRoleForAccountResponse
S3Uri
The URI of the source model in an Amazon S3 bucket. The model package must be in tar.gz or .zipformat.
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
GetServiceRoleForAccountResponse{ "AssociatedAt": "string", "RoleArn": "string"}
GetServiceRoleForAccountResponse
type: objectAssociatedAt
The time when the service role was associated with the account.
type: stringRoleArn
The ARN of the role which is associated with the account.
type: string
GetSubscriptionDefinitionVersionResponse{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }}
GetSubscriptionDefinitionVersionResponse
Information about a subscription definition version.
type: object
494
AWS Greengrass API ReferenceGetSubscriptionDefinitionVersionResponse
Arn
The ARN of the subscription definition version.
type: stringId
The ID of the subscription definition version.
type: stringVersion
The version of the subscription definition version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the subscription definition version was created.
type: stringDefinition
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 the subscriptiondefinition 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' (which representsthe AWS IoT cloud), or 'GGShadowService'.
495
AWS Greengrass API ReferenceGroup
type: string
Group{ "AssociatedAt": "string"}
Group
type: objectAssociatedAt
The time, in milliseconds since the epoch, when the role ARN was associated with the group.
type: string
Group Certificate Authority Properties{ "GroupCertificateAuthorityId": "string", "GroupCertificateAuthorityArn": "string"}
Group Certificate Authority Properties
Information about a certificate authority for a group.
type: objectGroupCertificateAuthorityId
The ID of the certificate authority for the group.
type: stringGroupCertificateAuthorityArn
The ARN of the certificate authority for the group.
type: string
GroupCertificateConfiguration{ "GroupId": "string", "CertificateAuthorityExpiryInMilliseconds": "string", "CertificateExpiryInMilliseconds": "string"}
GroupCertificateConfiguration
Information about a group certificate configuration.
type: object
496
AWS Greengrass API ReferenceGroupInformation
GroupId
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: string
GroupInformation{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string"}
GroupInformation
Information about a group.
type: objectName
The name of the group.
type: stringId
The ID of the group.
type: stringArn
The ARN of the group.
type: stringLastUpdatedTimestamp
The time, in milliseconds since the epoch, when the group was last updated.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the group was created.
type: string
497
AWS Greengrass API ReferenceGroupOwnerSetting
LatestVersion
The latest version of the group.
type: stringLatestVersionArn
The ARN of the latest version of the group.
type: string
GroupOwnerSetting{ "AutoAddGroupOwner": true, "GroupOwner": "string"}
GroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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.
type: booleanGroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
type: string
GroupVersion{ "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string"}
GroupVersion
Information about a group version.
type: objectCoreDefinitionVersionArn
The ARN of the core definition version for this group.
498
AWS Greengrass API ReferenceIDList
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
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",
499
AWS Greengrass API ReferenceListDefinitionsResponse
"LatestVersionArn": "string" } ], "NextToken": "string"}
ListDefinitionsResponse
A list of definitions.
type: objectDefinitions
Information about a definition.
type: array
items: DefinitionInformation (p. 464)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: string
500
AWS Greengrass API ReferenceListDeploymentsRequest
NextToken
The token for the next set of results, or null if there are no additional results.
type: string
ListDeploymentsRequest{ "MaxResults": 0, "NextToken": "string"}
ListDeploymentsRequest
type: objectMaxResults
The maximum number of results to be returned per request.
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"}
ListDeploymentsResponse
type: objectDeployments
type: array
501
AWS Greengrass API ReferenceListGroupCertificateAuthoritiesResponse
items: Deployment (p. 465)Deployment
Information about a deployment.
type: objectGroupArn
The ARN of the group for this deployment.
type: stringDeploymentId
The ID of the deployment.
type: stringDeploymentArn
The ARN of the deployment.
type: stringDeploymentType
type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]CreatedAt
The time, in milliseconds since the epoch, when the deployment was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
in: query
type: string
ListGroupCertificateAuthoritiesResponse{ "GroupCertificateAuthorities": [ { "GroupCertificateAuthorityId": "string", "GroupCertificateAuthorityArn": "string" } ]}
ListGroupCertificateAuthoritiesResponse
type: objectGroupCertificateAuthorities
A list of certificate authorities associated with the group.
type: array
502
AWS Greengrass API ReferenceListGroupsResponse
items: GroupCertificateAuthorityProperties (p. 496)Group Certificate Authority Properties
Information about a certificate authority for a group.
type: objectGroupCertificateAuthorityId
The ID of the certificate authority for the group.
type: stringGroupCertificateAuthorityArn
The ARN of the certificate authority for the group.
type: string
ListGroupsResponse{ "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
Information about a group.
type: objectName
The name of the group.
type: stringId
The ID of the group.
503
AWS Greengrass API ReferenceListVersionsResponse
type: stringArn
The ARN of the group.
type: stringLastUpdatedTimestamp
The time, in milliseconds since the epoch, when the group was last updated.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the group was created.
type: stringLatestVersion
The latest version of the group.
type: stringLatestVersionArn
The ARN of the latest version of the group.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string
ListVersionsResponse{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string"}
ListVersionsResponse
A list of versions.
type: objectVersions
Information about a version.
type: array
items: VersionInformation (p. 523)
504
AWS Greengrass API ReferenceLocalDeviceResourceData
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: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: stringNextToken
The token for the next set of results, or null if there are no additional results.
type: string
LocalDeviceResourceData{ "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" }}
LocalDeviceResourceData
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 refer onlyto a character device or block device under /dev.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: object
505
AWS Greengrass API ReferenceLocalVolumeResourceData
AutoAddGroupOwner
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.
type: booleanGroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
type: string
LocalVolumeResourceData{ "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" }}
LocalVolumeResourceData
Attributes that define a local volume resource.
type: objectSourcePath
The local absolute path of the volume resource on the host. The source path for a volume resourcetype cannot start with /proc or /sys.
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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.
type: booleanGroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
506
AWS Greengrass API ReferenceLogger
type: string
Logger{ "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0}
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 logger definitionversion. 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: integer
LoggerComponent{}
type: string
enum: ["GreengrassSystem", "Lambda"]
507
AWS Greengrass API ReferenceLoggerDefinitionVersion
LoggerDefinitionVersion{ "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ]}
LoggerDefinitionVersion
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 logger definitionversion. 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.
508
AWS Greengrass API ReferenceLoggerLevel
type: integer
LoggerLevel{}
type: string
enum: ["DEBUG", "INFO", "WARN", "ERROR", "FATAL"]
LoggerType{}
type: string
enum: ["FileSystem", "AWSCloudWatch"]
Permission{}
The type of permission a function has to access a resource.
type: string
enum: ["ro", "rw"]
ResetDeploymentsRequest{ "Force": true}
ResetDeploymentsRequest
Information about a group reset request.
type: objectForce
If true, performs a best-effort only core reset.
type: boolean
509
AWS Greengrass API ReferenceResetDeploymentsResponse
ResetDeploymentsResponse{ "DeploymentArn": "string", "DeploymentId": "string"}
ResetDeploymentsResponse
type: objectDeploymentArn
The ARN of the deployment.
type: stringDeploymentId
The ID of the deployment.
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
Information about a resource.
type: object
510
AWS Greengrass API ReferenceResource
required: ["Id", "Name", "ResourceDataContainer"]Id
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: 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 refer onlyto a character device or block device under /dev.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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.
type: booleanGroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
type: stringLocalVolumeResourceData
Attributes that define a local volume resource.
type: object
511
AWS Greengrass API ReferenceResource
SourcePath
The local absolute path of the volume resource on the host. The source path for a volume resourcetype cannot start with /proc or /sys.
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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.
type: booleanGroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
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.gz or .zipformat.
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
512
AWS Greengrass API ReferenceResourceAccessPolicy
type: string
ResourceAccessPolicy{ "ResourceId": "string", "Permission": "ro|rw"}
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 resource definiton.)
type: stringPermission
The type of permission a function has to access a resource.
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" }}
513
AWS Greengrass API ReferenceResourceDataContainer
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 refer onlyto a character device or block device under /dev.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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.
type: booleanGroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
type: stringLocalVolumeResourceData
Attributes that define a local volume resource.
type: objectSourcePath
The local absolute path of the volume resource on the host. The source path for a volume resourcetype cannot start with /proc or /sys.
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: object
514
AWS Greengrass API ReferenceResourceDefinitionVersion
AutoAddGroupOwner
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.
type: booleanGroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
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.gz or .zipformat.
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
ResourceDefinitionVersion{ "Resources": [ { "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true,
515
AWS Greengrass API ReferenceResourceDefinitionVersion
"GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "SageMakerMachineLearningModelResourceData": { "SageMakerJobArn": "string", "DestinationPath": "string" }, "S3MachineLearningModelResourceData": { "S3Uri": "string", "DestinationPath": "string" } } } ]}
ResourceDefinitionVersion
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 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: stringResourceDataContainer
A container for resource data. The container takes only one of thefollowing supported resource data types: LocalDeviceResourceData,LocalVolumeResourceData, SageMakerMachineLearningModelResourceData,S3MachineLearningModelResourceData.
516
AWS Greengrass API ReferenceResourceDefinitionVersion
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 refer onlyto a character device or block device under /dev.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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.
type: booleanGroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
type: stringLocalVolumeResourceData
Attributes that define a local volume resource.
type: objectSourcePath
The local absolute path of the volume resource on the host. The source path for a volume resourcetype cannot start with /proc or /sys.
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: stringGroupOwnerSetting
Group owner related settings for local resources.
type: objectAutoAddGroupOwner
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.
517
AWS Greengrass API ReferenceS3MachineLearningModelResourceData
type: booleanGroupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field isoptional.
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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
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.gz or .zipformat.
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
S3MachineLearningModelResourceData{ "S3Uri": "string", "DestinationPath": "string"}
S3MachineLearningModelResourceData
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.gz or .zipformat.
518
AWS Greengrass API ReferenceS3UrlSignerRole
type: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
S3UrlSignerRole{}
The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the updateartifact.
type: string
SageMakerMachineLearningModelResourceData{ "SageMakerJobArn": "string", "DestinationPath": "string"}
SageMakerMachineLearningModelResourceData
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: stringDestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
SoftwareToUpdate{}
The piece of software on the Greengrass core that will be updated.
type: string
enum: ["core", "ota_agent"]
519
AWS Greengrass API ReferenceSubscription
Subscription{ "Id": "string", "Source": "string", "Subject": "string", "Target": "string"}
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 the subscriptiondefinition 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' (which representsthe AWS IoT cloud), or 'GGShadowService'.
type: string
SubscriptionDefinitionVersion{ "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ]}
SubscriptionDefinitionVersion
Information about a subscription definition version.
520
AWS Greengrass API ReferenceUpdateAgentLogLevel
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 the subscriptiondefinition 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' (which representsthe AWS IoT cloud), or 'GGShadowService'.
type: string
UpdateAgentLogLevel{}
The minimum level of log statements that should be logged by the OTA Agent during an update.
type: string
enum: ["NONE", "TRACE", "DEBUG", "VERBOSE", "INFO", "WARN", "ERROR", "FATAL"]
UpdateConnectivityInfoRequest{ "ConnectivityInfo": [
521
AWS Greengrass API ReferenceUpdateConnectivityInfoResponse
{ "Id": "string", "HostAddress": "string", "PortNumber": 0x01, "Metadata": "string" } ]}
Information required to update a Greengrass core's connectivity.ConnectivityInfo
A list of connectivity info.
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: string
UpdateConnectivityInfoResponse{ "message": "string", "Version": "string"}
message
A message about the connectivity info update request.
type: string
522
AWS Greengrass API ReferenceUpdateTargets
Version
The new version of the connectivity info.
type: string
UpdateTargets{}
The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.
type: array
UpdateTargetsArchitecture{}
The architecture of the cores which are the targets of an update.
type: string
enum: ["armv7l", "x86_64", "aarch64"]
UpdateTargetsOperatingSystem{}
The operating system of the cores which are the targets of an update.
type: string
enum: ["ubuntu", "raspbian", "amazon_linux"]
VersionInformation{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string"}
VersionInformation
Information about a version.
523
AWS Greengrass API ReferenceVersions
type: objectArn
The ARN of the version.
type: stringId
The ID of the version.
type: stringVersion
The unique ID of the version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: string
Versions{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ]}
Versions
type: objectVersions
A list of versions.
type: array
items: VersionInformation (p. 523)VersionInformation
Information about a version.
type: objectArn
The ARN of the version.
type: stringId
The ID of the version.
524
AWS Greengrass API ReferenceupdateGroupCertificateConfigurationRequest
type: stringVersion
The unique ID of the version.
type: stringCreationTimestamp
The time, in milliseconds since the epoch, when the version was created.
type: string
updateGroupCertificateConfigurationRequest{ "CertificateExpiryInMilliseconds": "string"}
updateGroupCertificateConfigurationRequest
type: object
required: ["CertificateExpiryInMilliseconds"]CertificateExpiryInMilliseconds
The amount of time remaining before the certificate expires, in milliseconds.
type: string
525