GreengrassV2ClientProtocol

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.

public protocol GreengrassV2ClientProtocol 

Requirements

batchAssociateClientDeviceWithCoreDevice(input:completion:)

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

func batchAssociateClientDeviceWithCoreDevice(input: BatchAssociateClientDeviceWithCoreDeviceInput, completion: @escaping (ClientRuntime.SdkResult<BatchAssociateClientDeviceWithCoreDeviceOutputResponse, BatchAssociateClientDeviceWithCoreDeviceOutputError>) -> Void)

batchDisassociateClientDeviceFromCoreDevice(input:completion:)

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

func batchDisassociateClientDeviceFromCoreDevice(input: BatchDisassociateClientDeviceFromCoreDeviceInput, completion: @escaping (ClientRuntime.SdkResult<BatchDisassociateClientDeviceFromCoreDeviceOutputResponse, BatchDisassociateClientDeviceFromCoreDeviceOutputError>) -> Void)

cancelDeployment(input:completion:)

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.

func cancelDeployment(input: CancelDeploymentInput, completion: @escaping (ClientRuntime.SdkResult<CancelDeploymentOutputResponse, CancelDeploymentOutputError>) -> Void)

createComponentVersion(input:completion:)

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:

func createComponentVersion(input: CreateComponentVersionInput, completion: @escaping (ClientRuntime.SdkResult<CreateComponentVersionOutputResponse, CreateComponentVersionOutputError>) -> Void)

• Create components from recipes Create a component from a recipe, which is a file that defines the component’s metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see IoT Greengrass component recipe reference in the IoT Greengrass V2 Developer Guide. To create a component from a recipe, specify inlineRecipe when you call this operation.

• Create components from Lambda functions Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function’s deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2. This function only accepts Lambda functions that use the following runtimes:

• Python 2.7 – python2.7

• Python 3.7 – python3.7

• Python 3.8 – python3.8

• Java 8 – java8

• Node.js 10 – nodejs10.x

• Node.js 12 – nodejs12.x

To create a component from a Lambda function, specify lambdaFunction when you call this operation.

createDeployment(input:completion:)

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. This operation returns the revision number of the new deployment when you create it. For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide.

func createDeployment(input: CreateDeploymentInput, completion: @escaping (ClientRuntime.SdkResult<CreateDeploymentOutputResponse, CreateDeploymentOutputError>) -> Void)

deleteComponent(input:completion:)

Deletes a version of a component from IoT Greengrass. 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.

func deleteComponent(input: DeleteComponentInput, completion: @escaping (ClientRuntime.SdkResult<DeleteComponentOutputResponse, DeleteComponentOutputError>) -> Void)

deleteCoreDevice(input:completion:)

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.

func deleteCoreDevice(input: DeleteCoreDeviceInput, completion: @escaping (ClientRuntime.SdkResult<DeleteCoreDeviceOutputResponse, DeleteCoreDeviceOutputError>) -> Void)

describeComponent(input:completion:)

Retrieves metadata for a version of a component.

func describeComponent(input: DescribeComponentInput, completion: @escaping (ClientRuntime.SdkResult<DescribeComponentOutputResponse, DescribeComponentOutputError>) -> Void)

getComponent(input:completion:)

Gets the recipe for a version of a component. Core devices can call this operation to identify the artifacts and requirements to install a component.

func getComponent(input: GetComponentInput, completion: @escaping (ClientRuntime.SdkResult<GetComponentOutputResponse, GetComponentOutputError>) -> Void)

getComponentVersionArtifact(input:completion:)

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

func getComponentVersionArtifact(input: GetComponentVersionArtifactInput, completion: @escaping (ClientRuntime.SdkResult<GetComponentVersionArtifactOutputResponse, GetComponentVersionArtifactOutputError>) -> Void)

getCoreDevice(input:completion:)

Retrieves metadata for a Greengrass core device.

func getCoreDevice(input: GetCoreDeviceInput, completion: @escaping (ClientRuntime.SdkResult<GetCoreDeviceOutputResponse, GetCoreDeviceOutputError>) -> Void)

getDeployment(input:completion:)

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

func getDeployment(input: GetDeploymentInput, completion: @escaping (ClientRuntime.SdkResult<GetDeploymentOutputResponse, GetDeploymentOutputError>) -> Void)

listClientDevicesAssociatedWithCoreDevice(input:completion:)

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

func listClientDevicesAssociatedWithCoreDevice(input: ListClientDevicesAssociatedWithCoreDeviceInput, completion: @escaping (ClientRuntime.SdkResult<ListClientDevicesAssociatedWithCoreDeviceOutputResponse, ListClientDevicesAssociatedWithCoreDeviceOutputError>) -> Void)

listComponents(input:completion:)

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

func listComponents(input: ListComponentsInput, completion: @escaping (ClientRuntime.SdkResult<ListComponentsOutputResponse, ListComponentsOutputError>) -> Void)

listComponentVersions(input:completion:)

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

func listComponentVersions(input: ListComponentVersionsInput, completion: @escaping (ClientRuntime.SdkResult<ListComponentVersionsOutputResponse, ListComponentVersionsOutputError>) -> Void)

listCoreDevices(input:completion:)

Retrieves a paginated list of Greengrass core devices.

func listCoreDevices(input: ListCoreDevicesInput, completion: @escaping (ClientRuntime.SdkResult<ListCoreDevicesOutputResponse, ListCoreDevicesOutputError>) -> Void)

listDeployments(input:completion:)

Retrieves a paginated list of deployments.

func listDeployments(input: ListDeploymentsInput, completion: @escaping (ClientRuntime.SdkResult<ListDeploymentsOutputResponse, ListDeploymentsOutputError>) -> Void)

listEffectiveDeployments(input:completion:)

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

func listEffectiveDeployments(input: ListEffectiveDeploymentsInput, completion: @escaping (ClientRuntime.SdkResult<ListEffectiveDeploymentsOutputResponse, ListEffectiveDeploymentsOutputError>) -> Void)

listInstalledComponents(input:completion:)

Retrieves a paginated list of the components that a Greengrass core device runs.

func listInstalledComponents(input: ListInstalledComponentsInput, completion: @escaping (ClientRuntime.SdkResult<ListInstalledComponentsOutputResponse, ListInstalledComponentsOutputError>) -> Void)

listTagsForResource(input:completion:)

Retrieves the list of tags for an IoT Greengrass resource.

func listTagsForResource(input: ListTagsForResourceInput, completion: @escaping (ClientRuntime.SdkResult<ListTagsForResourceOutputResponse, ListTagsForResourceOutputError>) -> Void)

resolveComponentCandidates(input:completion:)

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.

func resolveComponentCandidates(input: ResolveComponentCandidatesInput, completion: @escaping (ClientRuntime.SdkResult<ResolveComponentCandidatesOutputResponse, ResolveComponentCandidatesOutputError>) -> Void)

tagResource(input:completion:)

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

func tagResource(input: TagResourceInput, completion: @escaping (ClientRuntime.SdkResult<TagResourceOutputResponse, TagResourceOutputError>) -> Void)

untagResource(input:completion:)

Removes a tag from an IoT Greengrass resource.

func untagResource(input: UntagResourceInput, completion: @escaping (ClientRuntime.SdkResult<UntagResourceOutputResponse, UntagResourceOutputError>) -> Void)