@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSGreengrassV2Async extends AbstractAWSGreengrassV2 implements AWSGreengrassV2Async
AWSGreengrassV2Async. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler, which throws an
UnsupportedOperationException.ENDPOINT_PREFIXcancelDeployment, createComponentVersion, createDeployment, deleteComponent, deleteCoreDevice, describeComponent, getCachedResponseMetadata, getComponent, getComponentVersionArtifact, getCoreDevice, getDeployment, listComponents, listComponentVersions, listCoreDevices, listDeployments, listEffectiveDeployments, listInstalledComponents, listTagsForResource, resolveComponentCandidates, shutdown, tagResource, untagResourceequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcancelDeployment, createComponentVersion, createDeployment, deleteComponent, deleteCoreDevice, describeComponent, getCachedResponseMetadata, getComponent, getComponentVersionArtifact, getCoreDevice, getDeployment, listComponents, listComponentVersions, listCoreDevices, listDeployments, listEffectiveDeployments, listInstalledComponents, listTagsForResource, resolveComponentCandidates, shutdown, tagResource, untagResourcepublic Future<CancelDeploymentResult> cancelDeploymentAsync(CancelDeploymentRequest request)
AWSGreengrassV2AsyncCancels 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.
cancelDeploymentAsync in interface AWSGreengrassV2Asyncpublic Future<CancelDeploymentResult> cancelDeploymentAsync(CancelDeploymentRequest request, AsyncHandler<CancelDeploymentRequest,CancelDeploymentResult> asyncHandler)
AWSGreengrassV2AsyncCancels 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.
cancelDeploymentAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<CreateComponentVersionResult> createComponentVersionAsync(CreateComponentVersionRequest request)
AWSGreengrassV2AsyncCreates 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 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.
createComponentVersionAsync in interface AWSGreengrassV2Asyncpublic Future<CreateComponentVersionResult> createComponentVersionAsync(CreateComponentVersionRequest request, AsyncHandler<CreateComponentVersionRequest,CreateComponentVersionResult> asyncHandler)
AWSGreengrassV2AsyncCreates 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 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.
createComponentVersionAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<CreateDeploymentResult> createDeploymentAsync(CreateDeploymentRequest request)
AWSGreengrassV2AsyncCreates 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 in the AWS IoT Greengrass V2 Developer Guide.
createDeploymentAsync in interface AWSGreengrassV2Asyncpublic Future<CreateDeploymentResult> createDeploymentAsync(CreateDeploymentRequest request, AsyncHandler<CreateDeploymentRequest,CreateDeploymentResult> asyncHandler)
AWSGreengrassV2AsyncCreates 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 in the AWS IoT Greengrass V2 Developer Guide.
createDeploymentAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<DeleteComponentResult> deleteComponentAsync(DeleteComponentRequest request)
AWSGreengrassV2AsyncDeletes 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.
deleteComponentAsync in interface AWSGreengrassV2Asyncpublic Future<DeleteComponentResult> deleteComponentAsync(DeleteComponentRequest request, AsyncHandler<DeleteComponentRequest,DeleteComponentResult> asyncHandler)
AWSGreengrassV2AsyncDeletes 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.
deleteComponentAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<DeleteCoreDeviceResult> deleteCoreDeviceAsync(DeleteCoreDeviceRequest request)
AWSGreengrassV2AsyncDeletes 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.
deleteCoreDeviceAsync in interface AWSGreengrassV2Asyncpublic Future<DeleteCoreDeviceResult> deleteCoreDeviceAsync(DeleteCoreDeviceRequest request, AsyncHandler<DeleteCoreDeviceRequest,DeleteCoreDeviceResult> asyncHandler)
AWSGreengrassV2AsyncDeletes 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.
deleteCoreDeviceAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<DescribeComponentResult> describeComponentAsync(DescribeComponentRequest request)
AWSGreengrassV2AsyncRetrieves metadata for a version of a component.
describeComponentAsync in interface AWSGreengrassV2Asyncpublic Future<DescribeComponentResult> describeComponentAsync(DescribeComponentRequest request, AsyncHandler<DescribeComponentRequest,DescribeComponentResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves metadata for a version of a component.
describeComponentAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<GetComponentResult> getComponentAsync(GetComponentRequest request)
AWSGreengrassV2AsyncGets the recipe for a version of a component. Core devices can call this operation to identify the artifacts and requirements to install a component.
getComponentAsync in interface AWSGreengrassV2Asyncpublic Future<GetComponentResult> getComponentAsync(GetComponentRequest request, AsyncHandler<GetComponentRequest,GetComponentResult> asyncHandler)
AWSGreengrassV2AsyncGets the recipe for a version of a component. Core devices can call this operation to identify the artifacts and requirements to install a component.
getComponentAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<GetComponentVersionArtifactResult> getComponentVersionArtifactAsync(GetComponentVersionArtifactRequest request)
AWSGreengrassV2AsyncGets 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.
getComponentVersionArtifactAsync in interface AWSGreengrassV2Asyncpublic Future<GetComponentVersionArtifactResult> getComponentVersionArtifactAsync(GetComponentVersionArtifactRequest request, AsyncHandler<GetComponentVersionArtifactRequest,GetComponentVersionArtifactResult> asyncHandler)
AWSGreengrassV2AsyncGets 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.
getComponentVersionArtifactAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<GetCoreDeviceResult> getCoreDeviceAsync(GetCoreDeviceRequest request)
AWSGreengrassV2AsyncRetrieves metadata for a AWS IoT Greengrass core device.
getCoreDeviceAsync in interface AWSGreengrassV2Asyncpublic Future<GetCoreDeviceResult> getCoreDeviceAsync(GetCoreDeviceRequest request, AsyncHandler<GetCoreDeviceRequest,GetCoreDeviceResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves metadata for a AWS IoT Greengrass core device.
getCoreDeviceAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<GetDeploymentResult> getDeploymentAsync(GetDeploymentRequest request)
AWSGreengrassV2AsyncGets a deployment. Deployments define the components that run on AWS IoT Greengrass core devices.
getDeploymentAsync in interface AWSGreengrassV2Asyncpublic Future<GetDeploymentResult> getDeploymentAsync(GetDeploymentRequest request, AsyncHandler<GetDeploymentRequest,GetDeploymentResult> asyncHandler)
AWSGreengrassV2AsyncGets a deployment. Deployments define the components that run on AWS IoT Greengrass core devices.
getDeploymentAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<ListComponentVersionsResult> listComponentVersionsAsync(ListComponentVersionsRequest request)
AWSGreengrassV2AsyncRetrieves a paginated list of all versions for a component.
listComponentVersionsAsync in interface AWSGreengrassV2Asyncpublic Future<ListComponentVersionsResult> listComponentVersionsAsync(ListComponentVersionsRequest request, AsyncHandler<ListComponentVersionsRequest,ListComponentVersionsResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves a paginated list of all versions for a component.
listComponentVersionsAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<ListComponentsResult> listComponentsAsync(ListComponentsRequest request)
AWSGreengrassV2AsyncRetrieves a paginated list of component summaries. This list includes components that you have permission to view.
listComponentsAsync in interface AWSGreengrassV2Asyncpublic Future<ListComponentsResult> listComponentsAsync(ListComponentsRequest request, AsyncHandler<ListComponentsRequest,ListComponentsResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves a paginated list of component summaries. This list includes components that you have permission to view.
listComponentsAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<ListCoreDevicesResult> listCoreDevicesAsync(ListCoreDevicesRequest request)
AWSGreengrassV2AsyncRetrieves a paginated list of AWS IoT Greengrass core devices.
listCoreDevicesAsync in interface AWSGreengrassV2Asyncpublic Future<ListCoreDevicesResult> listCoreDevicesAsync(ListCoreDevicesRequest request, AsyncHandler<ListCoreDevicesRequest,ListCoreDevicesResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves a paginated list of AWS IoT Greengrass core devices.
listCoreDevicesAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<ListDeploymentsResult> listDeploymentsAsync(ListDeploymentsRequest request)
AWSGreengrassV2AsyncRetrieves a paginated list of deployments.
listDeploymentsAsync in interface AWSGreengrassV2Asyncpublic Future<ListDeploymentsResult> listDeploymentsAsync(ListDeploymentsRequest request, AsyncHandler<ListDeploymentsRequest,ListDeploymentsResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves a paginated list of deployments.
listDeploymentsAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<ListEffectiveDeploymentsResult> listEffectiveDeploymentsAsync(ListEffectiveDeploymentsRequest request)
AWSGreengrassV2AsyncRetrieves a paginated list of deployment jobs that AWS IoT Greengrass sends to AWS IoT Greengrass core devices.
listEffectiveDeploymentsAsync in interface AWSGreengrassV2Asyncpublic Future<ListEffectiveDeploymentsResult> listEffectiveDeploymentsAsync(ListEffectiveDeploymentsRequest request, AsyncHandler<ListEffectiveDeploymentsRequest,ListEffectiveDeploymentsResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves a paginated list of deployment jobs that AWS IoT Greengrass sends to AWS IoT Greengrass core devices.
listEffectiveDeploymentsAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<ListInstalledComponentsResult> listInstalledComponentsAsync(ListInstalledComponentsRequest request)
AWSGreengrassV2AsyncRetrieves a paginated list of the components that a AWS IoT Greengrass core device runs.
listInstalledComponentsAsync in interface AWSGreengrassV2Asyncpublic Future<ListInstalledComponentsResult> listInstalledComponentsAsync(ListInstalledComponentsRequest request, AsyncHandler<ListInstalledComponentsRequest,ListInstalledComponentsResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves a paginated list of the components that a AWS IoT Greengrass core device runs.
listInstalledComponentsAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSGreengrassV2AsyncRetrieves the list of tags for an AWS IoT Greengrass resource.
listTagsForResourceAsync in interface AWSGreengrassV2Asyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves the list of tags for an AWS IoT Greengrass resource.
listTagsForResourceAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<ResolveComponentCandidatesResult> resolveComponentCandidatesAsync(ResolveComponentCandidatesRequest request)
AWSGreengrassV2AsyncRetrieves 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.
resolveComponentCandidatesAsync in interface AWSGreengrassV2Asyncpublic Future<ResolveComponentCandidatesResult> resolveComponentCandidatesAsync(ResolveComponentCandidatesRequest request, AsyncHandler<ResolveComponentCandidatesRequest,ResolveComponentCandidatesResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves 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.
resolveComponentCandidatesAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSGreengrassV2AsyncAdds tags to an AWS IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
tagResourceAsync in interface AWSGreengrassV2Asyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSGreengrassV2AsyncAdds tags to an AWS IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
tagResourceAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSGreengrassV2AsyncRemoves a tag from an AWS IoT Greengrass resource.
untagResourceAsync in interface AWSGreengrassV2Asyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSGreengrassV2AsyncRemoves a tag from an AWS IoT Greengrass resource.
untagResourceAsync in interface AWSGreengrassV2AsyncasyncHandler - 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.