@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSGreengrassV2AsyncClient extends AWSGreengrassV2Client implements AWSGreengrassV2Async
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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.
configFactoryclient, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIXassociateServiceRoleToAccount, batchAssociateClientDeviceWithCoreDevice, batchDisassociateClientDeviceFromCoreDevice, builder, cancelDeployment, createComponentVersion, createDeployment, deleteComponent, deleteCoreDevice, deleteDeployment, describeComponent, disassociateServiceRoleFromAccount, getCachedResponseMetadata, getComponent, getComponentVersionArtifact, getConnectivityInfo, getCoreDevice, getDeployment, getServiceRoleForAccount, listClientDevicesAssociatedWithCoreDevice, listComponents, listComponentVersions, listCoreDevices, listDeployments, listEffectiveDeployments, listInstalledComponents, listTagsForResource, resolveComponentCandidates, tagResource, untagResource, updateConnectivityInfoaddRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitassociateServiceRoleToAccount, batchAssociateClientDeviceWithCoreDevice, batchDisassociateClientDeviceFromCoreDevice, cancelDeployment, createComponentVersion, createDeployment, deleteComponent, deleteCoreDevice, deleteDeployment, describeComponent, disassociateServiceRoleFromAccount, getCachedResponseMetadata, getComponent, getComponentVersionArtifact, getConnectivityInfo, getCoreDevice, getDeployment, getServiceRoleForAccount, listClientDevicesAssociatedWithCoreDevice, listComponents, listComponentVersions, listCoreDevices, listDeployments, listEffectiveDeployments, listInstalledComponents, listTagsForResource, resolveComponentCandidates, tagResource, untagResource, updateConnectivityInfopublic static AWSGreengrassV2AsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AssociateServiceRoleToAccountResult> associateServiceRoleToAccountAsync(AssociateServiceRoleToAccountRequest request)
AWSGreengrassV2AsyncAssociates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that defines equivalent permissions for the IoT Greengrass features that you use. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
associateServiceRoleToAccountAsync in interface AWSGreengrassV2Asyncpublic Future<AssociateServiceRoleToAccountResult> associateServiceRoleToAccountAsync(AssociateServiceRoleToAccountRequest request, AsyncHandler<AssociateServiceRoleToAccountRequest,AssociateServiceRoleToAccountResult> asyncHandler)
AWSGreengrassV2AsyncAssociates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that defines equivalent permissions for the IoT Greengrass features that you use. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
associateServiceRoleToAccountAsync 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<BatchAssociateClientDeviceWithCoreDeviceResult> batchAssociateClientDeviceWithCoreDeviceAsync(BatchAssociateClientDeviceWithCoreDeviceRequest request)
AWSGreengrassV2AsyncAssociates 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.
batchAssociateClientDeviceWithCoreDeviceAsync in interface AWSGreengrassV2Asyncpublic Future<BatchAssociateClientDeviceWithCoreDeviceResult> batchAssociateClientDeviceWithCoreDeviceAsync(BatchAssociateClientDeviceWithCoreDeviceRequest request, AsyncHandler<BatchAssociateClientDeviceWithCoreDeviceRequest,BatchAssociateClientDeviceWithCoreDeviceResult> asyncHandler)
AWSGreengrassV2AsyncAssociates 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.
batchAssociateClientDeviceWithCoreDeviceAsync 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<BatchDisassociateClientDeviceFromCoreDeviceResult> batchDisassociateClientDeviceFromCoreDeviceAsync(BatchDisassociateClientDeviceFromCoreDeviceRequest request)
AWSGreengrassV2AsyncDisassociates 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.
batchDisassociateClientDeviceFromCoreDeviceAsync in interface AWSGreengrassV2Asyncpublic Future<BatchDisassociateClientDeviceFromCoreDeviceResult> batchDisassociateClientDeviceFromCoreDeviceAsync(BatchDisassociateClientDeviceFromCoreDeviceRequest request, AsyncHandler<BatchDisassociateClientDeviceFromCoreDeviceRequest,BatchDisassociateClientDeviceFromCoreDeviceResult> asyncHandler)
AWSGreengrassV2AsyncDisassociates 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.
batchDisassociateClientDeviceFromCoreDeviceAsync 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<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 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 accepts Lambda functions in all supported versions of Python, Node.js, and Java runtimes. IoT Greengrass doesn't apply any additional restrictions on deprecated Lambda runtime versions.
To create a component from a Lambda function, specify lambdaFunction when you call this operation.
IoT Greengrass currently supports Lambda functions on only Linux core devices.
createComponentVersionAsync in interface AWSGreengrassV2Asyncpublic Future<CreateComponentVersionResult> createComponentVersionAsync(CreateComponentVersionRequest request, AsyncHandler<CreateComponentVersionRequest,CreateComponentVersionResult> asyncHandler)
AWSGreengrassV2AsyncCreates 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 accepts Lambda functions in all supported versions of Python, Node.js, and Java runtimes. IoT Greengrass doesn't apply any additional restrictions on deprecated Lambda runtime versions.
To create a component from a Lambda function, specify lambdaFunction when you call this operation.
IoT Greengrass currently supports Lambda functions on only Linux core devices.
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 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.
For more information, see the Create deployments in the 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 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.
For more information, see the Create deployments in the 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 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 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 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.
deleteCoreDeviceAsync in interface AWSGreengrassV2Asyncpublic Future<DeleteCoreDeviceResult> deleteCoreDeviceAsync(DeleteCoreDeviceRequest request, AsyncHandler<DeleteCoreDeviceRequest,DeleteCoreDeviceResult> asyncHandler)
AWSGreengrassV2AsyncDeletes 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.
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<DeleteDeploymentResult> deleteDeploymentAsync(DeleteDeploymentRequest request)
AWSGreengrassV2AsyncDeletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment.
Deleting a deployment doesn't affect core devices that run that deployment, because core devices store the deployment's configuration on the device. Additionally, core devices can roll back to a previous deployment that has been deleted.
deleteDeploymentAsync in interface AWSGreengrassV2Asyncpublic Future<DeleteDeploymentResult> deleteDeploymentAsync(DeleteDeploymentRequest request, AsyncHandler<DeleteDeploymentRequest,DeleteDeploymentResult> asyncHandler)
AWSGreengrassV2AsyncDeletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment.
Deleting a deployment doesn't affect core devices that run that deployment, because core devices store the deployment's configuration on the device. Additionally, core devices can roll back to a previous deployment that has been deleted.
deleteDeploymentAsync 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<DisassociateServiceRoleFromAccountResult> disassociateServiceRoleFromAccountAsync(DisassociateServiceRoleFromAccountRequest request)
AWSGreengrassV2AsyncDisassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
disassociateServiceRoleFromAccountAsync in interface AWSGreengrassV2Asyncpublic Future<DisassociateServiceRoleFromAccountResult> disassociateServiceRoleFromAccountAsync(DisassociateServiceRoleFromAccountRequest request, AsyncHandler<DisassociateServiceRoleFromAccountRequest,DisassociateServiceRoleFromAccountResult> asyncHandler)
AWSGreengrassV2AsyncDisassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
disassociateServiceRoleFromAccountAsync 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.
getComponentAsync in interface AWSGreengrassV2Asyncpublic Future<GetComponentResult> getComponentAsync(GetComponentRequest request, AsyncHandler<GetComponentRequest,GetComponentResult> asyncHandler)
AWSGreengrassV2AsyncGets the recipe for a version of 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 download a public or a Lambda component artifact. Core devices 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 download a public or a Lambda component artifact. Core devices 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<GetConnectivityInfoResult> getConnectivityInfoAsync(GetConnectivityInfoRequest request)
AWSGreengrassV2AsyncRetrieves connectivity information for a Greengrass core device.
Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.
getConnectivityInfoAsync in interface AWSGreengrassV2Asyncpublic Future<GetConnectivityInfoResult> getConnectivityInfoAsync(GetConnectivityInfoRequest request, AsyncHandler<GetConnectivityInfoRequest,GetConnectivityInfoResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves connectivity information for a Greengrass core device.
Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.
getConnectivityInfoAsync 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 Greengrass core device.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
When the IoT Greengrass Core software starts
When the core device receives a deployment from the Amazon Web Services Cloud
When the status of any component on the core device becomes BROKEN
At a regular interval that you can configure, which defaults to 24 hours
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
getCoreDeviceAsync in interface AWSGreengrassV2Asyncpublic Future<GetCoreDeviceResult> getCoreDeviceAsync(GetCoreDeviceRequest request, AsyncHandler<GetCoreDeviceRequest,GetCoreDeviceResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves metadata for a Greengrass core device.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
When the IoT Greengrass Core software starts
When the core device receives a deployment from the Amazon Web Services Cloud
When the status of any component on the core device becomes BROKEN
At a regular interval that you can configure, which defaults to 24 hours
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
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 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 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<GetServiceRoleForAccountResult> getServiceRoleForAccountAsync(GetServiceRoleForAccountRequest request)
AWSGreengrassV2AsyncGets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
getServiceRoleForAccountAsync in interface AWSGreengrassV2Asyncpublic Future<GetServiceRoleForAccountResult> getServiceRoleForAccountAsync(GetServiceRoleForAccountRequest request, AsyncHandler<GetServiceRoleForAccountRequest,GetServiceRoleForAccountResult> asyncHandler)
AWSGreengrassV2AsyncGets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
getServiceRoleForAccountAsync 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<ListClientDevicesAssociatedWithCoreDeviceResult> listClientDevicesAssociatedWithCoreDeviceAsync(ListClientDevicesAssociatedWithCoreDeviceRequest request)
AWSGreengrassV2AsyncRetrieves a paginated list of client devices that are associated with a core device.
listClientDevicesAssociatedWithCoreDeviceAsync in interface AWSGreengrassV2Asyncpublic Future<ListClientDevicesAssociatedWithCoreDeviceResult> listClientDevicesAssociatedWithCoreDeviceAsync(ListClientDevicesAssociatedWithCoreDeviceRequest request, AsyncHandler<ListClientDevicesAssociatedWithCoreDeviceRequest,ListClientDevicesAssociatedWithCoreDeviceResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves a paginated list of client devices that are associated with a core device.
listClientDevicesAssociatedWithCoreDeviceAsync 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. Greater versions are listed first.
listComponentVersionsAsync in interface AWSGreengrassV2Asyncpublic Future<ListComponentVersionsResult> listComponentVersionsAsync(ListComponentVersionsRequest request, AsyncHandler<ListComponentVersionsRequest,ListComponentVersionsResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves a paginated list of all versions for a component. Greater versions are listed first.
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 Greengrass core devices.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
When the IoT Greengrass Core software starts
When the core device receives a deployment from the Amazon Web Services Cloud
When the status of any component on the core device becomes BROKEN
At a regular interval that you can configure, which defaults to 24 hours
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
listCoreDevicesAsync in interface AWSGreengrassV2Asyncpublic Future<ListCoreDevicesResult> listCoreDevicesAsync(ListCoreDevicesRequest request, AsyncHandler<ListCoreDevicesRequest,ListCoreDevicesResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves a paginated list of Greengrass core devices.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
When the IoT Greengrass Core software starts
When the core device receives a deployment from the Amazon Web Services Cloud
When the status of any component on the core device becomes BROKEN
At a regular interval that you can configure, which defaults to 24 hours
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
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 IoT Greengrass sends to Greengrass core devices.
listEffectiveDeploymentsAsync in interface AWSGreengrassV2Asyncpublic Future<ListEffectiveDeploymentsResult> listEffectiveDeploymentsAsync(ListEffectiveDeploymentsRequest request, AsyncHandler<ListEffectiveDeploymentsRequest,ListEffectiveDeploymentsResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves a paginated list of deployment jobs that IoT Greengrass sends to 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)
AWSGreengrassV2Async
Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't
include components that are deployed as dependencies of other components. To include dependencies in the
response, set the topologyFilter parameter to ALL.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
When the IoT Greengrass Core software starts
When the core device receives a deployment from the Amazon Web Services Cloud
When the status of any component on the core device becomes BROKEN
At a regular interval that you can configure, which defaults to 24 hours
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
listInstalledComponentsAsync in interface AWSGreengrassV2Asyncpublic Future<ListInstalledComponentsResult> listInstalledComponentsAsync(ListInstalledComponentsRequest request, AsyncHandler<ListInstalledComponentsRequest,ListInstalledComponentsResult> asyncHandler)
AWSGreengrassV2Async
Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't
include components that are deployed as dependencies of other components. To include dependencies in the
response, set the topologyFilter parameter to ALL.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
When the IoT Greengrass Core software starts
When the core device receives a deployment from the Amazon Web Services Cloud
When the status of any component on the core device becomes BROKEN
At a regular interval that you can configure, which defaults to 24 hours
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
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 IoT Greengrass resource.
listTagsForResourceAsync in interface AWSGreengrassV2Asyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSGreengrassV2AsyncRetrieves the list of tags for an 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. 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.
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. 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.
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 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 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 IoT Greengrass resource.
untagResourceAsync in interface AWSGreengrassV2Asyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSGreengrassV2AsyncRemoves a tag from an 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.public Future<UpdateConnectivityInfoResult> updateConnectivityInfoAsync(UpdateConnectivityInfoRequest request)
AWSGreengrassV2AsyncUpdates connectivity information for a Greengrass core device.
Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.
updateConnectivityInfoAsync in interface AWSGreengrassV2Asyncpublic Future<UpdateConnectivityInfoResult> updateConnectivityInfoAsync(UpdateConnectivityInfoRequest request, AsyncHandler<UpdateConnectivityInfoRequest,UpdateConnectivityInfoResult> asyncHandler)
AWSGreengrassV2AsyncUpdates connectivity information for a Greengrass core device.
Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.
updateConnectivityInfoAsync 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 void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSGreengrassV2shutdown in class AWSGreengrassV2ClientCopyright © 2024. All rights reserved.