GreengrassV2 class

AWS 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 AWS IoT Core and export IoT data to the AWS Cloud. AWS IoT Greengrass developers can use AWS Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.

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

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

Constructors

GreengrassV2({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cancelDeployment({required String deploymentId}) → Future<CancelDeploymentResponse>

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.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createComponentVersion({Uint8List? inlineRecipe, LambdaFunctionRecipeSource? lambdaFunction, Map<String, String>? tags}) → Future<CreateComponentVersionResponse>

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

createDeployment({required String targetArn, Map<String, ComponentDeploymentSpecification>? components, String? deploymentName, DeploymentPolicies? deploymentPolicies, DeploymentIoTJobConfiguration? iotJobConfiguration, Map<String, String>? tags}) → Future<CreateDeploymentResponse>

Creates a continuous deployment for a target, which is a AWS IoT 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, AWS IoT Greengrass deploys that group's deployment to the new device.

deleteComponent({required String arn}) → Future<void>

Deletes a version of a component from AWS IoT Greengrass.

deleteCoreDevice({required String coreDeviceThingName}) → Future<void>

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

describeComponent({required String arn}) → Future<DescribeComponentResponse>

Retrieves metadata for a version of a component.

getComponent({required String arn, RecipeOutputFormat? recipeOutputFormat}) → Future<GetComponentResponse>

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.

getComponentVersionArtifact({required String arn, required String artifactName}) → Future<GetComponentVersionArtifactResponse>

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

getCoreDevice({required String coreDeviceThingName}) → Future<GetCoreDeviceResponse>

Retrieves metadata for a AWS IoT Greengrass core device.

getDeployment({required String deploymentId}) → Future<GetDeploymentResponse>

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

listComponents({int? maxResults, String? nextToken, ComponentVisibilityScope? scope}) → Future<ListComponentsResponse>

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

listComponentVersions({required String arn, int? maxResults, String? nextToken}) → Future<ListComponentVersionsResponse>

Retrieves a paginated list of all versions for a component.

listCoreDevices({int? maxResults, String? nextToken, CoreDeviceStatus? status, String? thingGroupArn}) → Future<ListCoreDevicesResponse>

Retrieves a paginated list of AWS IoT Greengrass core devices.

listDeployments({DeploymentHistoryFilter? historyFilter, int? maxResults, String? nextToken, String? targetArn}) → Future<ListDeploymentsResponse>

Retrieves a paginated list of deployments.

listEffectiveDeployments({required String coreDeviceThingName, int? maxResults, String? nextToken}) → Future<ListEffectiveDeploymentsResponse>

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

listInstalledComponents({required String coreDeviceThingName, int? maxResults, String? nextToken}) → Future<ListInstalledComponentsResponse>

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

listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>

Retrieves the list of tags for an AWS IoT Greengrass resource.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

resolveComponentCandidates({required List<ComponentCandidate> componentCandidates, required ComponentPlatform platform}) → Future<ResolveComponentCandidatesResponse>

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

tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>

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

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

Removes a tag from an AWS IoT Greengrass resource.

Operators

operator ==(Object other) → bool

The equality operator.

inherited