View Source aws_greengrass (aws v1.0.4)
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.Summary
Functions
Associates a role with a group.
Associates a role with your account.
Creates a connector definition.
Creates a version of a connector definition which has already been defined.
Creates a core definition.
Creates a version of a core definition that has already been defined.
Creates a deployment.
Creates a device definition.
Creates a version of a device definition that has already been defined.
Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group.
Creates a version of a Lambda function definition that has already been defined.
Creates a group.
Creates a CA for the group.
Creates a version of a group which has already been defined.
Creates a logger definition.
Creates a version of a logger definition that has already been defined.
Creates a resource definition which contains a list of resources to be used in a group.
Creates a version of a resource definition that has already been defined.
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.
Creates a subscription definition.
Creates a version of a subscription definition which has already been defined.
Deletes a connector definition.
Deletes a core definition.
Deletes a device definition.
Deletes a Lambda function definition.
Deletes a group.
Deletes a logger definition.
Deletes a resource definition.
Deletes a subscription definition.
Disassociates the role from a group.
Disassociates the service role from your account.
Retrieves the role associated with a particular group.
Returns the status of a bulk deployment.
Retrieves the connectivity information for a core.
Retrieves information about a connector definition.
Retrieves information about a connector definition version, including the connectors that the version contains.
Retrieves information about a core definition version.
Retrieves information about a core definition version.
Returns the status of a deployment.
Retrieves information about a device definition.
Retrieves information about a device definition version.
Retrieves information about a Lambda function definition, including its creation time and latest version.
Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.
Retrieves information about a group.
Retreives the CA associated with a group.
Retrieves the current configuration for the CA used by the group.
Retrieves information about a group version.
Retrieves information about a logger definition.
Retrieves information about a logger definition version.
Retrieves information about a resource definition, including its creation time and latest version.
Retrieves information about a resource definition version, including which resources are included in the version.
Retrieves the service role that is attached to your account.
Retrieves information about a subscription definition.
Retrieves information about a subscription definition version.
Get the runtime configuration of a thing.
Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.
Returns a list of bulk deployments.
Lists the versions of a connector definition, which are containers for connectors.
Retrieves a list of connector definitions.
Lists the versions of a core definition.
Retrieves a list of core definitions.
Returns a history of deployments for the group.
Lists the versions of a device definition.
Retrieves a list of device definitions.
Lists the versions of a Lambda function definition.
Retrieves a list of Lambda function definitions.
Retrieves the current CAs for a group.
Lists the versions of a group.
Retrieves a list of groups.
Lists the versions of a logger definition.
Retrieves a list of logger definitions.
Lists the versions of a resource definition.
Retrieves a list of resource definitions.
Lists the versions of a subscription definition.
Retrieves a list of subscription definitions.
Retrieves a list of resource tags for a resource arn.
Resets a group's deployments.
Deploys multiple groups in one operation.
Stops the execution of a bulk deployment.
Adds tags to a Greengrass resource.
Remove resource tags from a Greengrass Resource.
Updates the connectivity information for the core.
Updates a connector definition.
Updates a core definition.
Updates a device definition.
Updates a Lambda function definition.
Updates a group.
Updates the Certificate expiry time for a group.
Updates a logger definition.
Updates a resource definition.
Updates a subscription definition.
Updates the runtime configuration of a thing.
Functions
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.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''.Creates a connector definition.
You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.
Link to this function
create_connector_definition_version(Client, ConnectorDefinitionId, Input)
View Source
Link to this function
create_connector_definition_version(Client, ConnectorDefinitionId, Input0, Options0)
View SourceCreates 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.Creates a version of a core definition that has already been defined.
Greengrass groups must each contain exactly one Greengrass core.
Link to this function
create_core_definition_version(Client, CoreDefinitionId, Input0, Options0)
View SourceCreates a deployment.
''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.Creates a device definition.
You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time.
Link to this function
create_device_definition_version(Client, DeviceDefinitionId, Input)
View Source
Link to this function
create_device_definition_version(Client, DeviceDefinitionId, Input0, Options0)
View SourceCreates 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.
Link to this function
create_function_definition_version(Client, FunctionDefinitionId, Input)
View Source
Link to this function
create_function_definition_version(Client, FunctionDefinitionId, Input0, Options0)
View SourceCreates 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.Creates a CA for the group.
If a CA already exists, it will rotate the existing CA.
Link to this function
create_group_certificate_authority(Client, GroupId, Input0, Options0)
View SourceCreates a logger definition.
You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time.
Link to this function
create_logger_definition_version(Client, LoggerDefinitionId, Input)
View Source
Link to this function
create_logger_definition_version(Client, LoggerDefinitionId, Input0, Options0)
View SourceCreates 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.
Link to this function
create_resource_definition_version(Client, ResourceDefinitionId, Input)
View Source
Link to this function
create_resource_definition_version(Client, ResourceDefinitionId, Input0, Options0)
View SourceCreates 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.Creates a subscription definition.
You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time.
Link to this function
create_subscription_definition_version(Client, SubscriptionDefinitionId, Input)
View Source
Link to this function
create_subscription_definition_version(Client, SubscriptionDefinitionId, Input0, Options0)
View Source
Link to this function
delete_connector_definition(Client, ConnectorDefinitionId, Input0, Options0)
View Source
Link to this function
delete_core_definition(Client, CoreDefinitionId, Input0, Options0)
View Source
Link to this function
delete_device_definition(Client, DeviceDefinitionId, Input0, Options0)
View Source
Link to this function
delete_function_definition(Client, FunctionDefinitionId, Input0, Options0)
View Source
Link to this function
delete_logger_definition(Client, LoggerDefinitionId, Input0, Options0)
View Source
Link to this function
delete_resource_definition(Client, ResourceDefinitionId, Input0, Options0)
View Source
Link to this function
delete_subscription_definition(Client, SubscriptionDefinitionId, Input)
View Source
Link to this function
delete_subscription_definition(Client, SubscriptionDefinitionId, Input0, Options0)
View SourceDisassociates the service role from your account.
Without a service role, deployments will not work.
Link to this function
get_associated_role(Client, GroupId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_bulk_deployment_status(Client, BulkDeploymentId, QueryMap, HeadersMap)
View Source
Link to this function
get_bulk_deployment_status(Client, BulkDeploymentId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_connectivity_info(Client, ThingName, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_connector_definition(Client, ConnectorDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
get_connector_definition(Client, ConnectorDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_connector_definition_version(Client, ConnectorDefinitionId, ConnectorDefinitionVersionId)
View SourceRetrieves 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.
Link to this function
get_connector_definition_version(Client, ConnectorDefinitionId, ConnectorDefinitionVersionId, QueryMap, HeadersMap)
View Source
Link to this function
get_connector_definition_version(Client, ConnectorDefinitionId, ConnectorDefinitionVersionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_core_definition(Client, CoreDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
get_core_definition(Client, CoreDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_core_definition_version(Client, CoreDefinitionId, CoreDefinitionVersionId)
View Source
Link to this function
get_core_definition_version(Client, CoreDefinitionId, CoreDefinitionVersionId, QueryMap, HeadersMap)
View Source
Link to this function
get_core_definition_version(Client, CoreDefinitionId, CoreDefinitionVersionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_deployment_status(Client, DeploymentId, GroupId, QueryMap, HeadersMap)
View Source
Link to this function
get_deployment_status(Client, DeploymentId, GroupId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_device_definition(Client, DeviceDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
get_device_definition(Client, DeviceDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_device_definition_version(Client, DeviceDefinitionId, DeviceDefinitionVersionId)
View Source
Link to this function
get_device_definition_version(Client, DeviceDefinitionId, DeviceDefinitionVersionId, QueryMap, HeadersMap)
View Source
Link to this function
get_device_definition_version(Client, DeviceDefinitionId, DeviceDefinitionVersionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_function_definition(Client, FunctionDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
get_function_definition(Client, FunctionDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_function_definition_version(Client, FunctionDefinitionId, FunctionDefinitionVersionId)
View Source
Link to this function
get_function_definition_version(Client, FunctionDefinitionId, FunctionDefinitionVersionId, QueryMap, HeadersMap)
View Source
Link to this function
get_function_definition_version(Client, FunctionDefinitionId, FunctionDefinitionVersionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_group_certificate_authority(Client, CertificateAuthorityId, GroupId)
View SourceRetreives the CA associated with a group.
Returns the public key of the CA.
Link to this function
get_group_certificate_authority(Client, CertificateAuthorityId, GroupId, QueryMap, HeadersMap)
View Source
Link to this function
get_group_certificate_authority(Client, CertificateAuthorityId, GroupId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_group_certificate_configuration(Client, GroupId, QueryMap, HeadersMap)
View Source
Link to this function
get_group_certificate_configuration(Client, GroupId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_group_version(Client, GroupId, GroupVersionId, QueryMap, HeadersMap)
View Source
Link to this function
get_group_version(Client, GroupId, GroupVersionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_logger_definition(Client, LoggerDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
get_logger_definition(Client, LoggerDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_logger_definition_version(Client, LoggerDefinitionId, LoggerDefinitionVersionId)
View Source
Link to this function
get_logger_definition_version(Client, LoggerDefinitionId, LoggerDefinitionVersionId, QueryMap, HeadersMap)
View Source
Link to this function
get_logger_definition_version(Client, LoggerDefinitionId, LoggerDefinitionVersionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_resource_definition(Client, ResourceDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
get_resource_definition(Client, ResourceDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_resource_definition_version(Client, ResourceDefinitionId, ResourceDefinitionVersionId)
View Source
Link to this function
get_resource_definition_version(Client, ResourceDefinitionId, ResourceDefinitionVersionId, QueryMap, HeadersMap)
View Source
Link to this function
get_resource_definition_version(Client, ResourceDefinitionId, ResourceDefinitionVersionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_service_role_for_account(Client, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_subscription_definition(Client, SubscriptionDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
get_subscription_definition(Client, SubscriptionDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_subscription_definition_version(Client, SubscriptionDefinitionId, SubscriptionDefinitionVersionId)
View Source
Link to this function
get_subscription_definition_version(Client, SubscriptionDefinitionId, SubscriptionDefinitionVersionId, QueryMap, HeadersMap)
View Source
Link to this function
get_subscription_definition_version(Client, SubscriptionDefinitionId, SubscriptionDefinitionVersionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_thing_runtime_configuration(Client, ThingName, QueryMap, HeadersMap)
View Source
Link to this function
get_thing_runtime_configuration(Client, ThingName, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_bulk_deployment_detailed_reports(Client, BulkDeploymentId, QueryMap, HeadersMap)
View Source
Link to this function
list_bulk_deployment_detailed_reports(Client, BulkDeploymentId, QueryMap, HeadersMap, Options0)
View SourceLists 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.
Link to this function
list_connector_definition_versions(Client, ConnectorDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
list_connector_definition_versions(Client, ConnectorDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_connector_definitions(Client, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_core_definition_versions(Client, CoreDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
list_core_definition_versions(Client, CoreDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_device_definition_versions(Client, DeviceDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
list_device_definition_versions(Client, DeviceDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_function_definition_versions(Client, FunctionDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
list_function_definition_versions(Client, FunctionDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_group_certificate_authorities(Client, GroupId, QueryMap, HeadersMap)
View Source
Link to this function
list_group_certificate_authorities(Client, GroupId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_group_versions(Client, GroupId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_logger_definition_versions(Client, LoggerDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
list_logger_definition_versions(Client, LoggerDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_resource_definition_versions(Client, ResourceDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
list_resource_definition_versions(Client, ResourceDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_subscription_definition_versions(Client, SubscriptionDefinitionId)
View Source
Link to this function
list_subscription_definition_versions(Client, SubscriptionDefinitionId, QueryMap, HeadersMap)
View Source
Link to this function
list_subscription_definition_versions(Client, SubscriptionDefinitionId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_subscription_definitions(Client, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceDeploys 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.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.Adds tags to a Greengrass resource.
Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'.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.
Link to this function
update_connector_definition(Client, ConnectorDefinitionId, Input0, Options0)
View Source
Link to this function
update_core_definition(Client, CoreDefinitionId, Input0, Options0)
View Source
Link to this function
update_device_definition(Client, DeviceDefinitionId, Input0, Options0)
View Source
Link to this function
update_function_definition(Client, FunctionDefinitionId, Input0, Options0)
View Source
Link to this function
update_group_certificate_configuration(Client, GroupId, Input0, Options0)
View Source
Link to this function
update_logger_definition(Client, LoggerDefinitionId, Input0, Options0)
View Source
Link to this function
update_resource_definition(Client, ResourceDefinitionId, Input0, Options0)
View Source
Link to this function
update_subscription_definition(Client, SubscriptionDefinitionId, Input)
View Source
Link to this function
update_subscription_definition(Client, SubscriptionDefinitionId, Input0, Options0)
View Source
Link to this function