AWS Fundamentals Logo
AWS Fundamentals
aws greengrass

AWS AWS IoT Greengrass CLI Commands

92 CLI commands available for AWS IoT Greengrass.

CommandSample
associate-role-to-group

Associates 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-account

Associates 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-definition

Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.

create-connector-definition-version

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

create-core-definition

Creates 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-version

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

create-deployment

Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.

create-device-definition

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

create-device-definition-version

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

create-function-definition

Creates 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-version

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

create-group

Creates 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-authority

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

create-group-version

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

create-logger-definition

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

create-logger-definition-version

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

create-resource-definition

Creates 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-version

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

create-software-update-job

Creates 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-definition

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

create-subscription-definition-version

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

delete-connector-definition

Deletes a connector definition.

delete-core-definition

Deletes a core definition.

delete-device-definition

Deletes a device definition.

delete-function-definition

Deletes a Lambda function definition.

delete-group

Deletes a group.

delete-logger-definition

Deletes a logger definition.

delete-resource-definition

Deletes a resource definition.

delete-subscription-definition

Deletes a subscription definition.

disassociate-role-from-group

Disassociates the role from a group.

disassociate-service-role-from-account

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

get-associated-role

Retrieves the role associated with a particular group.

get-bulk-deployment-status

Returns the status of a bulk deployment.

get-connectivity-info

Retrieves the connectivity information for a core.

get-connector-definition

Retrieves information about a connector definition.

get-connector-definition-version

Retrieves 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-definition

Retrieves information about a core definition version.

get-core-definition-version

Retrieves information about a core definition version.

get-deployment-status

Returns the status of a deployment.

get-device-definition

Retrieves information about a device definition.

get-device-definition-version

Retrieves information about a device definition version.

get-function-definition

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

get-function-definition-version

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

get-group

Retrieves information about a group.

get-group-certificate-authority

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

get-group-certificate-configuration

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

get-group-version

Retrieves information about a group version.

get-logger-definition

Retrieves information about a logger definition.

get-logger-definition-version

Retrieves information about a logger definition version.

get-resource-definition

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

get-resource-definition-version

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

get-service-role-for-account

Retrieves the service role that is attached to your account.

get-subscription-definition

Retrieves information about a subscription definition.

get-subscription-definition-version

Retrieves information about a subscription definition version.

get-thing-runtime-configuration

Get the runtime configuration of a thing.

list-bulk-deployment-detailed-reports

Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.

list-bulk-deployments

Returns a list of bulk deployments.

list-connector-definition-versions

Lists 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-definitions

Retrieves a list of connector definitions.

list-core-definition-versions

Lists the versions of a core definition.

list-core-definitions

Retrieves a list of core definitions.

list-deployments

Returns a history of deployments for the group.

list-device-definition-versions

Lists the versions of a device definition.

list-device-definitions

Retrieves a list of device definitions.

list-function-definition-versions

Lists the versions of a Lambda function definition.

list-function-definitions

Retrieves a list of Lambda function definitions.

list-group-certificate-authorities

Retrieves the current CAs for a group.

list-group-versions

Lists the versions of a group.

list-groups

Retrieves a list of groups.

list-logger-definition-versions

Lists the versions of a logger definition.

list-logger-definitions

Retrieves a list of logger definitions.

list-resource-definition-versions

Lists the versions of a resource definition.

list-resource-definitions

Retrieves a list of resource definitions.

list-subscription-definition-versions

Lists the versions of a subscription definition.

list-subscription-definitions

Retrieves a list of subscription definitions.

list-tags-for-resource

Retrieves a list of resource tags for a resource arn.

reset-deployments

Resets a group's deployments.

start-bulk-deployment

Deploys 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

stop-bulk-deployment

Stops 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-resource

Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'.

untag-resource

Remove resource tags from a Greengrass Resource.

update-connectivity-info

Updates 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-definition

Updates a connector definition.

update-core-definition

Updates a core definition.

update-device-definition

Updates a device definition.

update-function-definition

Updates a Lambda function definition.

update-group

Updates a group.

update-group-certificate-configuration

Updates the Certificate expiry time for a group.

update-logger-definition

Updates a logger definition.

update-resource-definition

Updates a resource definition.

update-subscription-definition

Updates a subscription definition.

update-thing-runtime-configuration

Updates the runtime configuration of a thing.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Stats

Total Commands92
ServiceGreengrass