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

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react autonomously to local events, and communicate securely with each other on local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.

IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console. Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components, manage deployments, and core devices.

For more information, see What is IoT Greengrass? in the IoT Greengrass V2 Developer Guide.

Sending a Request Using GreengrassV2

var greengrassv2 = new AWS.GreengrassV2();
greengrassv2.associateServiceRoleToAccount(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the GreengrassV2 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var greengrassv2 = new AWS.GreengrassV2({apiVersion: '2020-11-30'});

You can also set the API version globally in AWS.config.apiVersions using the greengrassv2 service identifier:

AWS.config.apiVersions = {
  greengrassv2: '2020-11-30',
  // other service API versions
};

var greengrassv2 = new AWS.GreengrassV2();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.GreengrassV2(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

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

Method Details

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

Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that defines equivalent permissions for the IoT Greengrass features that you use. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.

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

Associates a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the IoT Greengrass V2 Developer Guide.

Note: Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information, see Interact with local IoT devices in the IoT Greengrass V2 Developer Guide.

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

Disassociates a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.

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

Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.

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

Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices.

You can use this operation to do the following:

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

Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.

You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.

Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment.

For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide.

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

Deletes a version of a component from IoT Greengrass.

Note: This operation deletes the component's recipe and artifacts. As a result, deployments that refer to this component version will fail. If you have deployments that use this component version, you can remove the component from the deployment or update the deployment to use a valid version.

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

Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see DeleteThing in the IoT API Reference.

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

Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment.

Deleting a deployment doesn't affect core devices that run that deployment, because core devices store the deployment's configuration on the device. Additionally, core devices can roll back to a previous deployment that has been deleted.

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

Retrieves metadata for a version of a component.

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

Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.

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

Gets the recipe for a version of a component.

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

Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.

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

Retrieves connectivity information for a Greengrass core device.

Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.

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

Retrieves metadata for a Greengrass core device.

Note: IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times:

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

Gets a deployment. Deployments define the components that run on Greengrass core devices.

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

Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.

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

Retrieves a paginated list of client devices that are associated with a core device.

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

Retrieves a paginated list of component summaries. This list includes components that you have permission to view.

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

Retrieves a paginated list of all versions for a component. Greater versions are listed first.

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

Retrieves a paginated list of Greengrass core devices.

Note: IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times:

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

Retrieves a paginated list of deployments.

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

Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.

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

Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't include components that are deployed as dependencies of other components. To include dependencies in the response, set the topologyFilter parameter to ALL.

Note: IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times:

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

Retrieves the list of tags for an IoT Greengrass resource.

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

Retrieves a list of components that meet the component, version, and platform requirements of a deployment. Greengrass core devices call this operation when they receive a deployment to identify the components to install.

This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component A requires version >2.0.0 and component B requires version <2.0.0 of a component dependency.

When you specify the component candidates to resolve, IoT Greengrass compares each component's digest from the core device with the component's digest in the Amazon Web Services Cloud. If the digests don't match, then IoT Greengrass specifies to use the version from the Amazon Web Services Cloud.

To use this operation, you must use the data plane API endpoint and authenticate with an IoT device certificate. For more information, see IoT Greengrass endpoints and quotas.

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

Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.

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

Removes a tag from an IoT Greengrass resource.

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

Updates connectivity information for a Greengrass core device.

Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.