aws greengrass92 CLI commands available for AWS IoT Greengrass.
| Command | API Operation | Sample |
|---|---|---|
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. | AssociateRoleToGroup | |
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''. | AssociateServiceRoleToAccount | |
create-connector-definitionCreates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time. | CreateConnectorDefinition | |
create-connector-definition-versionCreates a version of a connector definition which has already been defined. | CreateConnectorDefinitionVersion | |
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. | CreateCoreDefinition | |
create-core-definition-versionCreates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core. | CreateCoreDefinitionVersion | |
create-deploymentCreates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters. | CreateDeployment | |
create-device-definitionCreates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time. | CreateDeviceDefinition | |
create-device-definition-versionCreates a version of a device definition that has already been defined. | CreateDeviceDefinitionVersion | |
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. | CreateFunctionDefinition | |
create-function-definition-versionCreates a version of a Lambda function definition that has already been defined. | CreateFunctionDefinitionVersion | |
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. | CreateGroup | |
create-group-certificate-authorityCreates a CA for the group. If a CA already exists, it will rotate the existing CA. | CreateGroupCertificateAuthority | |
create-group-versionCreates a version of a group which has already been defined. | CreateGroupVersion | |
create-logger-definitionCreates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time. | CreateLoggerDefinition | |
create-logger-definition-versionCreates a version of a logger definition that has already been defined. | CreateLoggerDefinitionVersion | |
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. | CreateResourceDefinition | |
create-resource-definition-versionCreates a version of a resource definition that has already been defined. | CreateResourceDefinitionVersion | |
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. | CreateSoftwareUpdateJob | |
create-subscription-definitionCreates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time. | CreateSubscriptionDefinition | |
create-subscription-definition-versionCreates a version of a subscription definition which has already been defined. | CreateSubscriptionDefinitionVersion | |
delete-connector-definitionDeletes a connector definition. | DeleteConnectorDefinition | |
delete-core-definitionDeletes a core definition. | DeleteCoreDefinition | |
delete-device-definitionDeletes a device definition. | DeleteDeviceDefinition | |
delete-function-definitionDeletes a Lambda function definition. | DeleteFunctionDefinition | |
delete-groupDeletes a group. | DeleteGroup | |
delete-logger-definitionDeletes a logger definition. | DeleteLoggerDefinition | |
delete-resource-definitionDeletes a resource definition. | DeleteResourceDefinition | |
delete-subscription-definitionDeletes a subscription definition. | DeleteSubscriptionDefinition | |
disassociate-role-from-groupDisassociates the role from a group. | DisassociateRoleFromGroup | |
disassociate-service-role-from-accountDisassociates the service role from your account. Without a service role, deployments will not work. | DisassociateServiceRoleFromAccount | |
get-associated-roleRetrieves the role associated with a particular group. | GetAssociatedRole | |
get-bulk-deployment-statusReturns the status of a bulk deployment. | GetBulkDeploymentStatus | |
get-connectivity-infoRetrieves the connectivity information for a core. | GetConnectivityInfo | |
get-connector-definitionRetrieves information about a connector definition. | GetConnectorDefinition | |
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. | GetConnectorDefinitionVersion | |
get-core-definitionRetrieves information about a core definition version. | GetCoreDefinition | |
get-core-definition-versionRetrieves information about a core definition version. | GetCoreDefinitionVersion | |
get-deployment-statusReturns the status of a deployment. | GetDeploymentStatus | |
get-device-definitionRetrieves information about a device definition. | GetDeviceDefinition | |
get-device-definition-versionRetrieves information about a device definition version. | GetDeviceDefinitionVersion | |
get-function-definitionRetrieves information about a Lambda function definition, including its creation time and latest version. | GetFunctionDefinition | |
get-function-definition-versionRetrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations. | GetFunctionDefinitionVersion | |
get-groupRetrieves information about a group. | GetGroup | |
get-group-certificate-authorityRetreives the CA associated with a group. Returns the public key of the CA. | GetGroupCertificateAuthority | |
get-group-certificate-configurationRetrieves the current configuration for the CA used by the group. | GetGroupCertificateConfiguration | |
get-group-versionRetrieves information about a group version. | GetGroupVersion | |
get-logger-definitionRetrieves information about a logger definition. | GetLoggerDefinition | |
get-logger-definition-versionRetrieves information about a logger definition version. | GetLoggerDefinitionVersion | |
get-resource-definitionRetrieves information about a resource definition, including its creation time and latest version. | GetResourceDefinition | |
get-resource-definition-versionRetrieves information about a resource definition version, including which resources are included in the version. | GetResourceDefinitionVersion | |
get-service-role-for-accountRetrieves the service role that is attached to your account. | GetServiceRoleForAccount | |
get-subscription-definitionRetrieves information about a subscription definition. | GetSubscriptionDefinition | |
get-subscription-definition-versionRetrieves information about a subscription definition version. | GetSubscriptionDefinitionVersion | |
get-thing-runtime-configurationGet the runtime configuration of a thing. | GetThingRuntimeConfiguration | |
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. | ListBulkDeploymentDetailedReports | |
list-bulk-deploymentsReturns a list of bulk deployments. | ListBulkDeployments | |
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. | ListConnectorDefinitionVersions | |
list-connector-definitionsRetrieves a list of connector definitions. | ListConnectorDefinitions | |
list-core-definition-versionsLists the versions of a core definition. | ListCoreDefinitionVersions | |
list-core-definitionsRetrieves a list of core definitions. | ListCoreDefinitions | |
list-deploymentsReturns a history of deployments for the group. | ListDeployments | |
list-device-definition-versionsLists the versions of a device definition. | ListDeviceDefinitionVersions | |
list-device-definitionsRetrieves a list of device definitions. | ListDeviceDefinitions | |
list-function-definition-versionsLists the versions of a Lambda function definition. | ListFunctionDefinitionVersions | |
list-function-definitionsRetrieves a list of Lambda function definitions. | ListFunctionDefinitions | |
list-group-certificate-authoritiesRetrieves the current CAs for a group. | ListGroupCertificateAuthorities | |
list-group-versionsLists the versions of a group. | ListGroupVersions | |
list-groupsRetrieves a list of groups. | ListGroups | |
list-logger-definition-versionsLists the versions of a logger definition. | ListLoggerDefinitionVersions | |
list-logger-definitionsRetrieves a list of logger definitions. | ListLoggerDefinitions | |
list-resource-definition-versionsLists the versions of a resource definition. | ListResourceDefinitionVersions | |
list-resource-definitionsRetrieves a list of resource definitions. | ListResourceDefinitions | |
list-subscription-definition-versionsLists the versions of a subscription definition. | ListSubscriptionDefinitionVersions | |
list-subscription-definitionsRetrieves a list of subscription definitions. | ListSubscriptionDefinitions | |
list-tags-for-resourceRetrieves a list of resource tags for a resource arn. | ListTagsForResource | |
reset-deploymentsResets a group's deployments. | ResetDeployments | |
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 ''StartBu | StartBulkDeployment | |
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. | StopBulkDeployment | |
tag-resourceAdds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'. | TagResource | |
untag-resourceRemove resource tags from a Greengrass Resource. | UntagResource | |
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. | UpdateConnectivityInfo | |
update-connector-definitionUpdates a connector definition. | UpdateConnectorDefinition | |
update-core-definitionUpdates a core definition. | UpdateCoreDefinition | |
update-device-definitionUpdates a device definition. | UpdateDeviceDefinition | |
update-function-definitionUpdates a Lambda function definition. | UpdateFunctionDefinition | |
update-groupUpdates a group. | UpdateGroup | |
update-group-certificate-configurationUpdates the Certificate expiry time for a group. | UpdateGroupCertificateConfiguration | |
update-logger-definitionUpdates a logger definition. | UpdateLoggerDefinition | |
update-resource-definitionUpdates a resource definition. | UpdateResourceDefinition | |
update-subscription-definitionUpdates a subscription definition. | UpdateSubscriptionDefinition | |
update-thing-runtime-configurationUpdates the runtime configuration of a thing. | UpdateThingRuntimeConfiguration |
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterGreengrass