AWS.Greengrass — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateRoleToGroup(params = {}, callback) ⇒ AWS.Request

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.

associateServiceRoleToAccount(params = {}, callback) ⇒ AWS.Request

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

createConnectorDefinition(params = {}, callback) ⇒ AWS.Request

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

createConnectorDefinitionVersion(params = {}, callback) ⇒ AWS.Request

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

createCoreDefinition(params = {}, callback) ⇒ AWS.Request

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.

createCoreDefinitionVersion(params = {}, callback) ⇒ AWS.Request

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

createDeployment(params = {}, callback) ⇒ AWS.Request

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

createDeviceDefinition(params = {}, callback) ⇒ AWS.Request

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

createDeviceDefinitionVersion(params = {}, callback) ⇒ AWS.Request

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

createFunctionDefinition(params = {}, callback) ⇒ AWS.Request

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.

createFunctionDefinitionVersion(params = {}, callback) ⇒ AWS.Request

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

createGroup(params = {}, callback) ⇒ AWS.Request

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.

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

createGroupVersion(params = {}, callback) ⇒ AWS.Request

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

createLoggerDefinition(params = {}, callback) ⇒ AWS.Request

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

createLoggerDefinitionVersion(params = {}, callback) ⇒ AWS.Request

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

createResourceDefinition(params = {}, callback) ⇒ AWS.Request

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.

createResourceDefinitionVersion(params = {}, callback) ⇒ AWS.Request

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

createSoftwareUpdateJob(params = {}, callback) ⇒ AWS.Request

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.

createSubscriptionDefinition(params = {}, callback) ⇒ AWS.Request

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

createSubscriptionDefinitionVersion(params = {}, callback) ⇒ AWS.Request

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

deleteConnectorDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a connector definition.

deleteCoreDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a core definition.

deleteDeviceDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a device definition.

deleteFunctionDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a Lambda function definition.

deleteLoggerDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a logger definition.

deleteResourceDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a resource definition.

deleteSubscriptionDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a subscription definition.

disassociateRoleFromGroup(params = {}, callback) ⇒ AWS.Request

Disassociates the role from a group.

disassociateServiceRoleFromAccount(params = {}, callback) ⇒ AWS.Request

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

getAssociatedRole(params = {}, callback) ⇒ AWS.Request

Retrieves the role associated with a particular group.

getBulkDeploymentStatus(params = {}, callback) ⇒ AWS.Request

Returns the status of a bulk deployment.

getConnectivityInfo(params = {}, callback) ⇒ AWS.Request

Retrieves the connectivity information for a core.

getConnectorDefinition(params = {}, callback) ⇒ AWS.Request

Retrieves information about a connector definition.

getConnectorDefinitionVersion(params = {}, callback) ⇒ AWS.Request

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.

getCoreDefinition(params = {}, callback) ⇒ AWS.Request

Retrieves information about a core definition version.

getCoreDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a core definition version.

getDeploymentStatus(params = {}, callback) ⇒ AWS.Request

Returns the status of a deployment.

getDeviceDefinition(params = {}, callback) ⇒ AWS.Request

Retrieves information about a device definition.

getDeviceDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a device definition version.

getFunctionDefinition(params = {}, callback) ⇒ AWS.Request

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

getFunctionDefinitionVersion(params = {}, callback) ⇒ AWS.Request

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

getGroup(params = {}, callback) ⇒ AWS.Request

Retrieves information about a group.

getGroupCertificateAuthority(params = {}, callback) ⇒ AWS.Request

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

getGroupCertificateConfiguration(params = {}, callback) ⇒ AWS.Request

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

getGroupVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a group version.

getLoggerDefinition(params = {}, callback) ⇒ AWS.Request

Retrieves information about a logger definition.

getLoggerDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a logger definition version.

getResourceDefinition(params = {}, callback) ⇒ AWS.Request

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

getResourceDefinitionVersion(params = {}, callback) ⇒ AWS.Request

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

getServiceRoleForAccount(params = {}, callback) ⇒ AWS.Request

Retrieves the service role that is attached to your account.

getSubscriptionDefinition(params = {}, callback) ⇒ AWS.Request

Retrieves information about a subscription definition.

getSubscriptionDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a subscription definition version.

getThingRuntimeConfiguration(params = {}, callback) ⇒ AWS.Request

Get the runtime configuration of a thing.

listBulkDeploymentDetailedReports(params = {}, callback) ⇒ AWS.Request

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

listBulkDeployments(params = {}, callback) ⇒ AWS.Request

Returns a list of bulk deployments.

listConnectorDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of connector definitions.

listConnectorDefinitionVersions(params = {}, callback) ⇒ AWS.Request

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.

listCoreDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of core definitions.

listCoreDefinitionVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a core definition.

listDeployments(params = {}, callback) ⇒ AWS.Request

Returns a history of deployments for the group.

listDeviceDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of device definitions.

listDeviceDefinitionVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a device definition.

listFunctionDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of Lambda function definitions.

listFunctionDefinitionVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a Lambda function definition.

listGroupCertificateAuthorities(params = {}, callback) ⇒ AWS.Request

Retrieves the current CAs for a group.

listGroups(params = {}, callback) ⇒ AWS.Request

Retrieves a list of groups.

listGroupVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a group.

listLoggerDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of logger definitions.

listLoggerDefinitionVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a logger definition.

listResourceDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of resource definitions.

listResourceDefinitionVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a resource definition.

listSubscriptionDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of subscription definitions.

listSubscriptionDefinitionVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a subscription definition.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Retrieves a list of resource tags for a resource arn.

resetDeployments(params = {}, callback) ⇒ AWS.Request

Resets a group's deployments.

startBulkDeployment(params = {}, callback) ⇒ AWS.Request

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.

stopBulkDeployment(params = {}, callback) ⇒ AWS.Request

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.

tagResource(params = {}, callback) ⇒ AWS.Request

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

untagResource(params = {}, callback) ⇒ AWS.Request

Remove resource tags from a Greengrass Resource.

updateConnectivityInfo(params = {}, callback) ⇒ AWS.Request

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.

updateConnectorDefinition(params = {}, callback) ⇒ AWS.Request

Updates a connector definition.

updateCoreDefinition(params = {}, callback) ⇒ AWS.Request

Updates a core definition.

updateDeviceDefinition(params = {}, callback) ⇒ AWS.Request

Updates a device definition.

updateFunctionDefinition(params = {}, callback) ⇒ AWS.Request

Updates a Lambda function definition.

updateGroupCertificateConfiguration(params = {}, callback) ⇒ AWS.Request

Updates the Certificate expiry time for a group.

updateLoggerDefinition(params = {}, callback) ⇒ AWS.Request

Updates a logger definition.

updateResourceDefinition(params = {}, callback) ⇒ AWS.Request

Updates a resource definition.

updateSubscriptionDefinition(params = {}, callback) ⇒ AWS.Request

Updates a subscription definition.

updateThingRuntimeConfiguration(params = {}, callback) ⇒ AWS.Request

Updates the runtime configuration of a thing.