com.amazonaws.services.greengrassv2.AWSGreengrassV2Async Maven / Gradle / Ivy
/*
* Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.greengrassv2;
import javax.annotation.Generated;
import com.amazonaws.services.greengrassv2.model.*;
/**
* Interface for accessing AWS GreengrassV2 asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.greengrassv2.AbstractAWSGreengrassV2Async} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSGreengrassV2Async extends AWSGreengrassV2 {
/**
*
* 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.
*
*
*
* @param batchAssociateClientDeviceWithCoreDeviceRequest
* @return A Java Future containing the result of the BatchAssociateClientDeviceWithCoreDevice operation returned by
* the service.
* @sample AWSGreengrassV2Async.BatchAssociateClientDeviceWithCoreDevice
* @see AWS API Documentation
*/
java.util.concurrent.Future batchAssociateClientDeviceWithCoreDeviceAsync(
BatchAssociateClientDeviceWithCoreDeviceRequest batchAssociateClientDeviceWithCoreDeviceRequest);
/**
*
* 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.
*
*
*
* @param batchAssociateClientDeviceWithCoreDeviceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the BatchAssociateClientDeviceWithCoreDevice operation returned by
* the service.
* @sample AWSGreengrassV2AsyncHandler.BatchAssociateClientDeviceWithCoreDevice
* @see AWS API Documentation
*/
java.util.concurrent.Future batchAssociateClientDeviceWithCoreDeviceAsync(
BatchAssociateClientDeviceWithCoreDeviceRequest batchAssociateClientDeviceWithCoreDeviceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param batchDisassociateClientDeviceFromCoreDeviceRequest
* @return A Java Future containing the result of the BatchDisassociateClientDeviceFromCoreDevice operation returned
* by the service.
* @sample AWSGreengrassV2Async.BatchDisassociateClientDeviceFromCoreDevice
* @see AWS API Documentation
*/
java.util.concurrent.Future batchDisassociateClientDeviceFromCoreDeviceAsync(
BatchDisassociateClientDeviceFromCoreDeviceRequest batchDisassociateClientDeviceFromCoreDeviceRequest);
/**
*
* 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.
*
*
* @param batchDisassociateClientDeviceFromCoreDeviceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the BatchDisassociateClientDeviceFromCoreDevice operation returned
* by the service.
* @sample AWSGreengrassV2AsyncHandler.BatchDisassociateClientDeviceFromCoreDevice
* @see AWS API Documentation
*/
java.util.concurrent.Future batchDisassociateClientDeviceFromCoreDeviceAsync(
BatchDisassociateClientDeviceFromCoreDeviceRequest batchDisassociateClientDeviceFromCoreDeviceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param cancelDeploymentRequest
* @return A Java Future containing the result of the CancelDeployment operation returned by the service.
* @sample AWSGreengrassV2Async.CancelDeployment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future cancelDeploymentAsync(CancelDeploymentRequest cancelDeploymentRequest);
/**
*
* 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.
*
*
* @param cancelDeploymentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CancelDeployment operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.CancelDeployment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future cancelDeploymentAsync(CancelDeploymentRequest cancelDeploymentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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:
*
*
* -
*
* 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.
*
*
*
*
* @param createComponentVersionRequest
* @return A Java Future containing the result of the CreateComponentVersion operation returned by the service.
* @sample AWSGreengrassV2Async.CreateComponentVersion
* @see AWS API Documentation
*/
java.util.concurrent.Future createComponentVersionAsync(CreateComponentVersionRequest createComponentVersionRequest);
/**
*
* 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:
*
*
* -
*
* 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.
*
*
*
*
* @param createComponentVersionRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateComponentVersion operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.CreateComponentVersion
* @see AWS API Documentation
*/
java.util.concurrent.Future createComponentVersionAsync(CreateComponentVersionRequest createComponentVersionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param createDeploymentRequest
* @return A Java Future containing the result of the CreateDeployment operation returned by the service.
* @sample AWSGreengrassV2Async.CreateDeployment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createDeploymentAsync(CreateDeploymentRequest createDeploymentRequest);
/**
*
* 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.
*
*
* @param createDeploymentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateDeployment operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.CreateDeployment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createDeploymentAsync(CreateDeploymentRequest createDeploymentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
* @param deleteComponentRequest
* @return A Java Future containing the result of the DeleteComponent operation returned by the service.
* @sample AWSGreengrassV2Async.DeleteComponent
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteComponentAsync(DeleteComponentRequest deleteComponentRequest);
/**
*
* 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.
*
*
*
* @param deleteComponentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteComponent operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.DeleteComponent
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteComponentAsync(DeleteComponentRequest deleteComponentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deleteCoreDeviceRequest
* @return A Java Future containing the result of the DeleteCoreDevice operation returned by the service.
* @sample AWSGreengrassV2Async.DeleteCoreDevice
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteCoreDeviceAsync(DeleteCoreDeviceRequest deleteCoreDeviceRequest);
/**
*
* 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.
*
*
* @param deleteCoreDeviceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteCoreDevice operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.DeleteCoreDevice
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteCoreDeviceAsync(DeleteCoreDeviceRequest deleteCoreDeviceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves metadata for a version of a component.
*
*
* @param describeComponentRequest
* @return A Java Future containing the result of the DescribeComponent operation returned by the service.
* @sample AWSGreengrassV2Async.DescribeComponent
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeComponentAsync(DescribeComponentRequest describeComponentRequest);
/**
*
* Retrieves metadata for a version of a component.
*
*
* @param describeComponentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeComponent operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.DescribeComponent
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeComponentAsync(DescribeComponentRequest describeComponentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param getComponentRequest
* @return A Java Future containing the result of the GetComponent operation returned by the service.
* @sample AWSGreengrassV2Async.GetComponent
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getComponentAsync(GetComponentRequest getComponentRequest);
/**
*
* 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.
*
*
* @param getComponentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetComponent operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.GetComponent
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getComponentAsync(GetComponentRequest getComponentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param getComponentVersionArtifactRequest
* @return A Java Future containing the result of the GetComponentVersionArtifact operation returned by the service.
* @sample AWSGreengrassV2Async.GetComponentVersionArtifact
* @see AWS API Documentation
*/
java.util.concurrent.Future getComponentVersionArtifactAsync(
GetComponentVersionArtifactRequest getComponentVersionArtifactRequest);
/**
*
* 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.
*
*
* @param getComponentVersionArtifactRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetComponentVersionArtifact operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.GetComponentVersionArtifact
* @see AWS API Documentation
*/
java.util.concurrent.Future getComponentVersionArtifactAsync(
GetComponentVersionArtifactRequest getComponentVersionArtifactRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves metadata for a Greengrass core device.
*
*
* @param getCoreDeviceRequest
* @return A Java Future containing the result of the GetCoreDevice operation returned by the service.
* @sample AWSGreengrassV2Async.GetCoreDevice
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getCoreDeviceAsync(GetCoreDeviceRequest getCoreDeviceRequest);
/**
*
* Retrieves metadata for a Greengrass core device.
*
*
* @param getCoreDeviceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetCoreDevice operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.GetCoreDevice
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getCoreDeviceAsync(GetCoreDeviceRequest getCoreDeviceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a deployment. Deployments define the components that run on Greengrass core devices.
*
*
* @param getDeploymentRequest
* @return A Java Future containing the result of the GetDeployment operation returned by the service.
* @sample AWSGreengrassV2Async.GetDeployment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getDeploymentAsync(GetDeploymentRequest getDeploymentRequest);
/**
*
* Gets a deployment. Deployments define the components that run on Greengrass core devices.
*
*
* @param getDeploymentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetDeployment operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.GetDeployment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getDeploymentAsync(GetDeploymentRequest getDeploymentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a paginated list of client devices that are associated with a core device.
*
*
* @param listClientDevicesAssociatedWithCoreDeviceRequest
* @return A Java Future containing the result of the ListClientDevicesAssociatedWithCoreDevice operation returned
* by the service.
* @sample AWSGreengrassV2Async.ListClientDevicesAssociatedWithCoreDevice
* @see AWS API Documentation
*/
java.util.concurrent.Future listClientDevicesAssociatedWithCoreDeviceAsync(
ListClientDevicesAssociatedWithCoreDeviceRequest listClientDevicesAssociatedWithCoreDeviceRequest);
/**
*
* Retrieves a paginated list of client devices that are associated with a core device.
*
*
* @param listClientDevicesAssociatedWithCoreDeviceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListClientDevicesAssociatedWithCoreDevice operation returned
* by the service.
* @sample AWSGreengrassV2AsyncHandler.ListClientDevicesAssociatedWithCoreDevice
* @see AWS API Documentation
*/
java.util.concurrent.Future listClientDevicesAssociatedWithCoreDeviceAsync(
ListClientDevicesAssociatedWithCoreDeviceRequest listClientDevicesAssociatedWithCoreDeviceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a paginated list of all versions for a component. Greater versions are listed first.
*
*
* @param listComponentVersionsRequest
* @return A Java Future containing the result of the ListComponentVersions operation returned by the service.
* @sample AWSGreengrassV2Async.ListComponentVersions
* @see AWS API Documentation
*/
java.util.concurrent.Future listComponentVersionsAsync(ListComponentVersionsRequest listComponentVersionsRequest);
/**
*
* Retrieves a paginated list of all versions for a component. Greater versions are listed first.
*
*
* @param listComponentVersionsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListComponentVersions operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.ListComponentVersions
* @see AWS API Documentation
*/
java.util.concurrent.Future listComponentVersionsAsync(ListComponentVersionsRequest listComponentVersionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a paginated list of component summaries. This list includes components that you have permission to
* view.
*
*
* @param listComponentsRequest
* @return A Java Future containing the result of the ListComponents operation returned by the service.
* @sample AWSGreengrassV2Async.ListComponents
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listComponentsAsync(ListComponentsRequest listComponentsRequest);
/**
*
* Retrieves a paginated list of component summaries. This list includes components that you have permission to
* view.
*
*
* @param listComponentsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListComponents operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.ListComponents
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listComponentsAsync(ListComponentsRequest listComponentsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a paginated list of Greengrass core devices.
*
*
* @param listCoreDevicesRequest
* @return A Java Future containing the result of the ListCoreDevices operation returned by the service.
* @sample AWSGreengrassV2Async.ListCoreDevices
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listCoreDevicesAsync(ListCoreDevicesRequest listCoreDevicesRequest);
/**
*
* Retrieves a paginated list of Greengrass core devices.
*
*
* @param listCoreDevicesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListCoreDevices operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.ListCoreDevices
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listCoreDevicesAsync(ListCoreDevicesRequest listCoreDevicesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a paginated list of deployments.
*
*
* @param listDeploymentsRequest
* @return A Java Future containing the result of the ListDeployments operation returned by the service.
* @sample AWSGreengrassV2Async.ListDeployments
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listDeploymentsAsync(ListDeploymentsRequest listDeploymentsRequest);
/**
*
* Retrieves a paginated list of deployments.
*
*
* @param listDeploymentsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListDeployments operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.ListDeployments
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listDeploymentsAsync(ListDeploymentsRequest listDeploymentsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
*
*
* @param listEffectiveDeploymentsRequest
* @return A Java Future containing the result of the ListEffectiveDeployments operation returned by the service.
* @sample AWSGreengrassV2Async.ListEffectiveDeployments
* @see AWS API Documentation
*/
java.util.concurrent.Future listEffectiveDeploymentsAsync(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest);
/**
*
* Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
*
*
* @param listEffectiveDeploymentsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListEffectiveDeployments operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.ListEffectiveDeployments
* @see AWS API Documentation
*/
java.util.concurrent.Future listEffectiveDeploymentsAsync(ListEffectiveDeploymentsRequest listEffectiveDeploymentsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a paginated list of the components that a Greengrass core device runs.
*
*
* @param listInstalledComponentsRequest
* @return A Java Future containing the result of the ListInstalledComponents operation returned by the service.
* @sample AWSGreengrassV2Async.ListInstalledComponents
* @see AWS API Documentation
*/
java.util.concurrent.Future listInstalledComponentsAsync(ListInstalledComponentsRequest listInstalledComponentsRequest);
/**
*
* Retrieves a paginated list of the components that a Greengrass core device runs.
*
*
* @param listInstalledComponentsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListInstalledComponents operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.ListInstalledComponents
* @see AWS API Documentation
*/
java.util.concurrent.Future listInstalledComponentsAsync(ListInstalledComponentsRequest listInstalledComponentsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the list of tags for an IoT Greengrass resource.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSGreengrassV2Async.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Retrieves the list of tags for an IoT Greengrass resource.
*
*
* @param listTagsForResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
* @param resolveComponentCandidatesRequest
* @return A Java Future containing the result of the ResolveComponentCandidates operation returned by the service.
* @sample AWSGreengrassV2Async.ResolveComponentCandidates
* @see AWS API Documentation
*/
java.util.concurrent.Future resolveComponentCandidatesAsync(
ResolveComponentCandidatesRequest resolveComponentCandidatesRequest);
/**
*
* 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.
*
*
*
* @param resolveComponentCandidatesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ResolveComponentCandidates operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.ResolveComponentCandidates
* @see AWS API Documentation
*/
java.util.concurrent.Future resolveComponentCandidatesAsync(
ResolveComponentCandidatesRequest resolveComponentCandidatesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the
* tag's value.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSGreengrassV2Async.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the
* tag's value.
*
*
* @param tagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes a tag from an IoT Greengrass resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSGreengrassV2Async.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes a tag from an IoT Greengrass resource.
*
*
* @param untagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSGreengrassV2AsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}