NAME

Paws::GreengrassV2 - Perl Interface to AWS AWS IoT Greengrass V2

SYNOPSIS

  use Paws;

  my $obj = Paws->service('GreengrassV2');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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? (https://docs.aws.amazon.com/greengrass/v2/developerguide/what-is-iot-greengrass.html) in the AWS IoT Greengrass V2 Developer Guide.

For the AWS API documentation, see https://docs.aws.amazon.com/greengrass/

METHODS

BatchAssociateClientDeviceWithCoreDevice

CoreDeviceThingName => Str
[Entries => ArrayRef[Paws::GreengrassV2::AssociateClientDeviceWithCoreDeviceEntry]]

Each argument is described in detail in: Paws::GreengrassV2::BatchAssociateClientDeviceWithCoreDevice

Returns: a Paws::GreengrassV2::BatchAssociateClientDeviceWithCoreDeviceResponse instance

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 AWS IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-cloud-discovery.html) in the AWS IoT Greengrass V2 Developer Guide.

Client devices are local IoT devices that connect to and communicate with an AWS IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to AWS IoT Core and interact with client devices in AWS IoT Greengrass components. For more information, see Interact with local IoT devices (https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html) in the AWS IoT Greengrass V2 Developer Guide.

BatchDisassociateClientDeviceFromCoreDevice

CoreDeviceThingName => Str
[Entries => ArrayRef[Paws::GreengrassV2::DisassociateClientDeviceFromCoreDeviceEntry]]

Each argument is described in detail in: Paws::GreengrassV2::BatchDisassociateClientDeviceFromCoreDevice

Returns: a Paws::GreengrassV2::BatchDisassociateClientDeviceFromCoreDeviceResponse instance

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.

CancelDeployment

DeploymentId => Str

Each argument is described in detail in: Paws::GreengrassV2::CancelDeployment

Returns: a Paws::GreengrassV2::CancelDeploymentResponse instance

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

[InlineRecipe => Str]
[LambdaFunction => Paws::GreengrassV2::LambdaFunctionRecipeSource]
[Tags => Paws::GreengrassV2::TagMap]

Each argument is described in detail in: Paws::GreengrassV2::CreateComponentVersion

Returns: a Paws::GreengrassV2::CreateComponentVersionResponse instance

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.

You can use this operation to do the following:

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 AWS IoT Greengrass component recipe reference (https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html) in the AWS 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 AWS Lambda function that runs on AWS 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 AWS IoT Greengrass V1 to AWS 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

TargetArn => Str
[Components => Paws::GreengrassV2::ComponentDeploymentSpecifications]
[DeploymentName => Str]
[DeploymentPolicies => Paws::GreengrassV2::DeploymentPolicies]
[IotJobConfiguration => Paws::GreengrassV2::DeploymentIoTJobConfiguration]
[Tags => Paws::GreengrassV2::TagMap]

Each argument is described in detail in: Paws::GreengrassV2::CreateDeployment

Returns: a Paws::GreengrassV2::CreateDeploymentResponse instance

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.

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. AWS 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 (https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the AWS IoT Greengrass V2 Developer Guide.

DeleteComponent

Arn => Str

Each argument is described in detail in: Paws::GreengrassV2::DeleteComponent

Returns: nothing

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

DeleteCoreDevice

CoreDeviceThingName => Str

Each argument is described in detail in: Paws::GreengrassV2::DeleteCoreDevice

Returns: nothing

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 (https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteThing.html) in the AWS IoT API Reference.

DescribeComponent

Arn => Str

Each argument is described in detail in: Paws::GreengrassV2::DescribeComponent

Returns: a Paws::GreengrassV2::DescribeComponentResponse instance

Retrieves metadata for a version of a component.

GetComponent

Arn => Str
[RecipeOutputFormat => Str]

Each argument is described in detail in: Paws::GreengrassV2::GetComponent

Returns: a Paws::GreengrassV2::GetComponentResponse instance

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

Arn => Str
ArtifactName => Str

Each argument is described in detail in: Paws::GreengrassV2::GetComponentVersionArtifact

Returns: a Paws::GreengrassV2::GetComponentVersionArtifactResponse instance

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.

GetCoreDevice

CoreDeviceThingName => Str

Each argument is described in detail in: Paws::GreengrassV2::GetCoreDevice

Returns: a Paws::GreengrassV2::GetCoreDeviceResponse instance

Retrieves metadata for a AWS IoT Greengrass core device.

GetDeployment

DeploymentId => Str

Each argument is described in detail in: Paws::GreengrassV2::GetDeployment

Returns: a Paws::GreengrassV2::GetDeploymentResponse instance

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

ListClientDevicesAssociatedWithCoreDevice

CoreDeviceThingName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GreengrassV2::ListClientDevicesAssociatedWithCoreDevice

Returns: a Paws::GreengrassV2::ListClientDevicesAssociatedWithCoreDeviceResponse instance

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

ListComponents

[MaxResults => Int]
[NextToken => Str]
[Scope => Str]

Each argument is described in detail in: Paws::GreengrassV2::ListComponents

Returns: a Paws::GreengrassV2::ListComponentsResponse instance

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

ListComponentVersions

Arn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GreengrassV2::ListComponentVersions

Returns: a Paws::GreengrassV2::ListComponentVersionsResponse instance

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

ListCoreDevices

[MaxResults => Int]
[NextToken => Str]
[Status => Str]
[ThingGroupArn => Str]

Each argument is described in detail in: Paws::GreengrassV2::ListCoreDevices

Returns: a Paws::GreengrassV2::ListCoreDevicesResponse instance

Retrieves a paginated list of AWS IoT Greengrass core devices.

ListDeployments

[HistoryFilter => Str]
[MaxResults => Int]
[NextToken => Str]
[TargetArn => Str]

Each argument is described in detail in: Paws::GreengrassV2::ListDeployments

Returns: a Paws::GreengrassV2::ListDeploymentsResponse instance

Retrieves a paginated list of deployments.

ListEffectiveDeployments

CoreDeviceThingName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GreengrassV2::ListEffectiveDeployments

Returns: a Paws::GreengrassV2::ListEffectiveDeploymentsResponse instance

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

ListInstalledComponents

CoreDeviceThingName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GreengrassV2::ListInstalledComponents

Returns: a Paws::GreengrassV2::ListInstalledComponentsResponse instance

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

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::GreengrassV2::ListTagsForResource

Returns: a Paws::GreengrassV2::ListTagsForResourceResponse instance

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

ResolveComponentCandidates

ComponentCandidates => ArrayRef[Paws::GreengrassV2::ComponentCandidate]
Platform => Paws::GreengrassV2::ComponentPlatform

Each argument is described in detail in: Paws::GreengrassV2::ResolveComponentCandidates

Returns: a Paws::GreengrassV2::ResolveComponentCandidatesResponse instance

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.

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, AWS IoT Greengrass compares each component's digest from the core device with the component's digest in the AWS Cloud. If the digests don't match, then AWS IoT Greengrass specifies to use the version from the AWS Cloud.

To use this operation, you must use the data plane API endpoint and authenticate with an AWS IoT device certificate. For more information, see AWS IoT Greengrass endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/greengrass.html).

TagResource

ResourceArn => Str
Tags => Paws::GreengrassV2::TagMap

Each argument is described in detail in: Paws::GreengrassV2::TagResource

Returns: a Paws::GreengrassV2::TagResourceResponse instance

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

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::GreengrassV2::UntagResource

Returns: a Paws::GreengrassV2::UntagResourceResponse instance

Removes a tag from an AWS IoT Greengrass resource.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results