aws greengrass

AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally

Subcommands

NameDescription
associate-role-to-groupAssociates a role with a group. Your 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 the cloud
associate-service-role-to-accountAssociates a role with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy ''AWSGreengrassResourceAccessRolePolicy''
create-connector-definitionCreates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time
create-connector-definition-versionCreates a version of a connector definition which has already been defined
create-core-definitionCreates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core
create-core-definition-versionCreates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core
create-deploymentCreates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters
create-device-definitionCreates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time
create-device-definition-versionCreates a version of a device definition that has already been defined
create-function-definitionCreates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use ''CreateFunctionDefinitionVersion'' later
create-function-definition-versionCreates a version of a Lambda function definition that has already been defined
create-groupCreates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups
create-group-certificate-authorityCreates a CA for the group. If a CA already exists, it will rotate the existing CA
create-group-versionCreates a version of a group which has already been defined
create-logger-definitionCreates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time
create-logger-definition-versionCreates a version of a logger definition that has already been defined
create-resource-definitionCreates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use ''CreateResourceDefinitionVersion'' later
create-resource-definition-versionCreates a version of a resource definition that has already been defined
create-software-update-jobCreates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job
create-subscription-definitionCreates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time
create-subscription-definition-versionCreates a version of a subscription definition which has already been defined
delete-connector-definitionDeletes a connector definition
delete-core-definitionDeletes a core definition
delete-device-definitionDeletes a device definition
delete-function-definitionDeletes a Lambda function definition
delete-groupDeletes a group
delete-logger-definitionDeletes a logger definition
delete-resource-definitionDeletes a resource definition
delete-subscription-definitionDeletes a subscription definition
disassociate-role-from-groupDisassociates the role from a group
disassociate-service-role-from-accountDisassociates the service role from your account. Without a service role, deployments will not work
get-associated-roleRetrieves the role associated with a particular group
get-bulk-deployment-statusReturns the status of a bulk deployment
get-connectivity-infoRetrieves the connectivity information for a core
get-connector-definitionRetrieves information about a connector definition
get-connector-definition-versionRetrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services
get-core-definitionRetrieves information about a core definition version
get-core-definition-versionRetrieves information about a core definition version
get-deployment-statusReturns the status of a deployment
get-device-definitionRetrieves information about a device definition
get-device-definition-versionRetrieves information about a device definition version
get-function-definitionRetrieves information about a Lambda function definition, including its creation time and latest version
get-function-definition-versionRetrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations
get-groupRetrieves information about a group
get-group-certificate-authorityRetrieves the CA associated with a group. Returns the public key of the CA
get-group-certificate-configurationRetrieves the current configuration for the CA used by the group
get-group-versionRetrieves information about a group version
get-logger-definitionRetrieves information about a logger definition
get-logger-definition-versionRetrieves information about a logger definition version
get-resource-definitionRetrieves information about a resource definition, including its creation time and latest version
get-resource-definition-versionRetrieves information about a resource definition version, including which resources are included in the version
get-service-role-for-accountRetrieves the service role that is attached to your account
get-subscription-definitionRetrieves information about a subscription definition
get-subscription-definition-versionRetrieves information about a subscription definition version
get-thing-runtime-configurationGet the runtime configuration of a thing
list-bulk-deployment-detailed-reportsGets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status
list-bulk-deploymentsReturns a list of bulk deployments
list-connector-definition-versionsLists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services
list-connector-definitionsRetrieves a list of connector definitions
list-core-definition-versionsLists the versions of a core definition
list-core-definitionsRetrieves a list of core definitions
list-deploymentsReturns a history of deployments for the group
list-device-definition-versionsLists the versions of a device definition
list-device-definitionsRetrieves a list of device definitions
list-function-definition-versionsLists the versions of a Lambda function definition
list-function-definitionsRetrieves a list of Lambda function definitions
list-group-certificate-authoritiesRetrieves the current CAs for a group
list-group-versionsLists the versions of a group
list-groupsRetrieves a list of groups
list-logger-definition-versionsLists the versions of a logger definition
list-logger-definitionsRetrieves a list of logger definitions
list-resource-definition-versionsLists the versions of a resource definition
list-resource-definitionsRetrieves a list of resource definitions
list-subscription-definition-versionsLists the versions of a subscription definition
list-subscription-definitionsRetrieves a list of subscription definitions
list-tags-for-resourceRetrieves a list of resource tags for a resource arn
reset-deploymentsResets a group's deployments
start-bulk-deploymentDeploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters
stop-bulk-deploymentStops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments
tag-resourceAdds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'
untag-resourceRemove resource tags from a Greengrass Resource
update-connectivity-infoUpdates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it
update-connector-definitionUpdates a connector definition
update-core-definitionUpdates a core definition
update-device-definitionUpdates a device definition
update-function-definitionUpdates a Lambda function definition
update-groupUpdates a group
update-group-certificate-configurationUpdates the Certificate expiry time for a group
update-logger-definitionUpdates a logger definition
update-resource-definitionUpdates a resource definition
update-subscription-definitionUpdates a subscription definition
update-thing-runtime-configurationUpdates the runtime configuration of a thing