amazonaws.com – greengrass

Tools (94)

Extracted live via the executor SDK.

• greengrass.associateRoleToGroup

  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.

• greengrass.associateServiceRoleToAccount

  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''.

• greengrass.createConnectorDefinition

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

• greengrass.createConnectorDefinitionVersion

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

• greengrass.createCoreDefinition

  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.

• greengrass.createCoreDefinitionVersion

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

• greengrass.createDeployment

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

• greengrass.createDeviceDefinition

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

• greengrass.createDeviceDefinitionVersion

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

• greengrass.createFunctionDefinition

  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.

• greengrass.createFunctionDefinitionVersion

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

• greengrass.createGroup

  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.

• greengrass.createGroupCertificateAuthority

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

• greengrass.createGroupVersion

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

• greengrass.createLoggerDefinition

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

• greengrass.createLoggerDefinitionVersion

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

• greengrass.createResourceDefinition

  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.

• greengrass.createResourceDefinitionVersion

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

• greengrass.createSoftwareUpdateJob

  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.

• greengrass.createSubscriptionDefinition

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

• greengrass.createSubscriptionDefinitionVersion

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

• greengrass.deleteConnectorDefinition

  Deletes a connector definition.

• greengrass.deleteCoreDefinition

  Deletes a core definition.

• greengrass.deleteDeviceDefinition

  Deletes a device definition.

• greengrass.deleteFunctionDefinition

  Deletes a Lambda function definition.

• greengrass.deleteGroup

  Deletes a group.

• greengrass.deleteLoggerDefinition

  Deletes a logger definition.

• greengrass.deleteResourceDefinition

  Deletes a resource definition.

• greengrass.deleteSubscriptionDefinition

  Deletes a subscription definition.

• greengrass.disassociateRoleFromGroup

  Disassociates the role from a group.

• greengrass.disassociateServiceRoleFromAccount

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

• greengrass.getAssociatedRole

  Retrieves the role associated with a particular group.

• greengrass.getBulkDeploymentStatus

  Returns the status of a bulk deployment.

• greengrass.getConnectivityInfo

  Retrieves the connectivity information for a core.

• greengrass.getConnectorDefinition

  Retrieves information about a connector definition.

• greengrass.getConnectorDefinitionVersion

  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.

• greengrass.getCoreDefinition

  Retrieves information about a core definition version.

• greengrass.getCoreDefinitionVersion

  Retrieves information about a core definition version.

• greengrass.getDeploymentStatus

  Returns the status of a deployment.

• greengrass.getDeviceDefinition

  Retrieves information about a device definition.

• greengrass.getDeviceDefinitionVersion

  Retrieves information about a device definition version.

• greengrass.getFunctionDefinition

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

• greengrass.getFunctionDefinitionVersion

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

• greengrass.getGroup

  Retrieves information about a group.

• greengrass.getGroupCertificateAuthority

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

• greengrass.getGroupCertificateConfiguration

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

• greengrass.getGroupVersion

  Retrieves information about a group version.

• greengrass.getLoggerDefinition

  Retrieves information about a logger definition.

• greengrass.getLoggerDefinitionVersion

  Retrieves information about a logger definition version.

• greengrass.getResourceDefinition

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

• greengrass.getResourceDefinitionVersion

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

• greengrass.getServiceRoleForAccount

  Retrieves the service role that is attached to your account.

• greengrass.getSubscriptionDefinition

  Retrieves information about a subscription definition.

• greengrass.getSubscriptionDefinitionVersion

  Retrieves information about a subscription definition version.

• greengrass.getThingRuntimeConfiguration

  Get the runtime configuration of a thing.

• greengrass.listBulkDeploymentDetailedReports

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

• greengrass.listBulkDeployments

  Returns a list of bulk deployments.

• greengrass.listConnectorDefinitions

  Retrieves a list of connector definitions.

• greengrass.listConnectorDefinitionVersions

  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.

• greengrass.listCoreDefinitions

  Retrieves a list of core definitions.

• greengrass.listCoreDefinitionVersions

  Lists the versions of a core definition.

• greengrass.listDeployments

  Returns a history of deployments for the group.

• greengrass.listDeviceDefinitions

  Retrieves a list of device definitions.

• greengrass.listDeviceDefinitionVersions

  Lists the versions of a device definition.

• greengrass.listFunctionDefinitions

  Retrieves a list of Lambda function definitions.

• greengrass.listFunctionDefinitionVersions

  Lists the versions of a Lambda function definition.

• greengrass.listGroupCertificateAuthorities

  Retrieves the current CAs for a group.

• greengrass.listGroups

  Retrieves a list of groups.

• greengrass.listGroupVersions

  Lists the versions of a group.

• greengrass.listLoggerDefinitions

  Retrieves a list of logger definitions.

• greengrass.listLoggerDefinitionVersions

  Lists the versions of a logger definition.

• greengrass.listResourceDefinitions

  Retrieves a list of resource definitions.

• greengrass.listResourceDefinitionVersions

  Lists the versions of a resource definition.

• greengrass.listSubscriptionDefinitions

  Retrieves a list of subscription definitions.

• greengrass.listSubscriptionDefinitionVersions

  Lists the versions of a subscription definition.

• greengrass.resetDeployments

  Resets a group's deployments.

• greengrass.startBulkDeployment

  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 ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters.

• greengrass.stopBulkDeployment

  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.

• greengrass.updateConnectivityInfo

  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.

• greengrass.updateConnectorDefinition

  Updates a connector definition.

• greengrass.updateCoreDefinition

  Updates a core definition.

• greengrass.updateDeviceDefinition

  Updates a device definition.

• greengrass.updateFunctionDefinition

  Updates a Lambda function definition.

• greengrass.updateGroup

  Updates a group.

• greengrass.updateGroupCertificateConfiguration

  Updates the Certificate expiry time for a group.

• greengrass.updateLoggerDefinition

  Updates a logger definition.

• greengrass.updateResourceDefinition

  Updates a resource definition.

• greengrass.updateSubscriptionDefinition

  Updates a subscription definition.

• greengrass.updateThingRuntimeConfiguration

  Updates the runtime configuration of a thing.

• tags.listTagsForResource

  Retrieves a list of resource tags for a resource arn.

• tags.tagResource

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

• tags.untagResource

  Remove resource tags from a Greengrass Resource.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools